Smartstaff
2,091
edits
Changes
m
In the case of [[Adobe Sign]] integration, this requires input of OAuth security token and Application ID which is available by signing into your Adobe ID account at [https://accounts.adobe.com/// https://accounts.adobe.com/]. See [[Adobe Sign]] for how to configure Adobe Sign e-signature documents. ===Retrieving Integration Keys===Integration keys can be retrieved from the Variable Processor via the following syntax. The ssGet variables will only get replaced when the api API call is made and will not resolve directly on the source of a page. This prevents exposing the credentials to the end user.
<pre> @ssGet(APIKEY,''keyname'',username''attribute'')@ returns the username from the "keyname" entry@ssGet(APIKEY,keyname,password)@ returns the password from the "keyname" entry
Example An example use of this would be using the built in service call function to make a RESTful API call:exservice_call(flag ,callbackfunc,fields,url)
url <pre>//service call syntax://exservice_call(syncflag, callbackfunc, fields, URL)//URL - the url URL to post the restful call to.//fields - contain all the parameters you may need (required is "svc=restful"), delimited by ';;'.
no edit summary
==Overview==
SmartSimple allows for the ability to store multiple the authentication credentials and for various integration end points to perform RESTful API calls to and external services. The purpose of this is to provide a single point of configuration for integration credentials that can then be referenced throughout the system.
Features include native integration for with services such as Salesforce , and Adobe Acrobat Sign, with as well any custom integrations available capable of transferring the integration key to other systems for authenticationend point.
==Configuring Integration Keys==
You need to have [[Global User Administrator]] permissions in order to access Integration key functions.
# Log-in to Within SmartSimple and , access the '''Global Settings''' page.
# Click on the '''Integrations''' tab and under '''Services Settings''', click on '''Integration Key Management''' link.
# This page will list all current integration keys configured for this instance of SmartSimple.
# Create a new Integration Key by clicking the''' +''' button on the top left.
# Select a Key Type, fill out the authentication details and click '''Save''' once complete.
[[File:Integration Key-1.PNG|800px600px]]
===Function Settings===
Each new integration key has the following fields below.
{| class="contenttable" style="height: 190px;" width="557"|-||* '''Key TypeTypes'''
** Custom
** [[Adobe Acrobat Sign]]** [[Salesforceintegration|Salesforce]]** Zoom** [[DocuSign]]** OAuth2** [[SignEasy]]** [[ORCID Integration|ORCID]]** General - File Transfer** PGP Key** SCOPUS** SignEasy** KeyStore** NCBI** Companies House** Configuration Exchange** Web of Science (WOS) ||[[Image: KeyTypes.png|330px]] |}* '''Key Name ''' - Unique name description for this integration key.* '''Authentication URL Security Token ''' - Integration End Point of Access token or integration key from the external service.* '''Security Token Authentication URL ''' - Access token or integration key from the end point of external service.
* '''Synchronization Direction '''
** From SmartSimple to External Service
* '''Password ''' - Password of API account
In the case of [[Adobe Acrobat Sign]] integration, this requires input of OAuth security token and Application ID which is available by signing into your Adobe ID account at [https://accounts.adobe.com https://accounts.adobe.com]. See the [[Adobe Acrobat Sign|Adobe Acrobat Sign article]] on this wiki for how to configure Adobe Acrobat Sign e-signature documents.
//given an Integration Key named 'myapi'exservice_call(false,"","svc=restful;;companyid=xxx;;alias=xxx;;username=@ssGet(APIKEY,keynamemyapi,username)@ ;;password=@ssGet(APIKEY,keynamemyapi,password)@ ;;apitoken=xxx;;reportid=xxx","httphttps://apismart.smartsimple.com.com/API/1/report/")
</pre>
[[Category:Integration]] [[Category:System Integration]]