Difference between revisions of "Integration Key Management"

From SmartWiki
Jump to: navigation, search
m
 
(17 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
==Overview==
 
==Overview==
−
SmartSimple allows for the ability to store multiple authentication credentials and integration end points to perform RESTful API calls to external services.
+
SmartSimple allows for the ability to store the authentication credentials for various integration end points 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 Salesforce and Adobe Sign, with custom integrations available capable of transferring the integration key to other systems for authentication.
+
Features include native integration with services such as Salesforce, and Adobe Acrobat Sign, as well any custom end point.
  
 
==Configuring Integration Keys==
 
==Configuring Integration Keys==
 
You need to have [[Global User Administrator]] permissions in order to access Integration key functions.
 
You need to have [[Global User Administrator]] permissions in order to access Integration key functions.
  
−
# Log-in to SmartSimple and access the '''Global Settings''' page.
+
# Within SmartSimple, access the '''Global Settings''' page.
 
# Click on the '''Integrations''' tab and under '''Services Settings''', click on '''Integration Key Management''' link.
 
# 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.
 
# This page will list all current integration keys configured for this instance of SmartSimple.
Line 13: Line 13:
 
# Select a Key Type, fill out the authentication details and click '''Save''' once complete.
 
# Select a Key Type, fill out the authentication details and click '''Save''' once complete.
  
−
 
+
[[File:Integration Key-1.PNG|600px]]
−
[[File:Integration Key-1.PNG|800px]]
 
−
 
 
−
 
 
  
 
===Function Settings===
 
===Function Settings===
 
Each new integration key has the following fields below.
 
Each new integration key has the following fields below.
  
−
* '''Key Type'''
+
{| class="contenttable" style="height: 190px;" width="557"
 +
|-
 +
||
 +
* '''Key Types'''
 
** Custom
 
** Custom
−
** Adobe Sign
+
** [[Adobe Acrobat Sign]]
−
** Salesforce
+
** [[Salesforce integration|Salesforce]]
−
* '''Key Name ''' - Unique name description for this integration key
+
** Zoom
−
* '''Authentication URL ''' - Integration End Point of external service
+
** [[DocuSign]]
−
* '''Security Token ''' - Access token or integration key from the external service
+
** 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]]
 +
 
 +
|}
 +
* '''Name ''' - Unique name description for this integration key.
 +
* '''Security Token ''' - Access token or integration key from the external service.
 +
* '''Authentication URL ''' - end point of external service.
 
* '''Synchronization Direction '''
 
* '''Synchronization Direction '''
 
** From SmartSimple to External Service 
 
** From SmartSimple to External Service 
Line 35: Line 54:
 
* '''Password ''' - Password of API account
 
* '''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.
−
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 the [[Adobe Sign|Adobe Sign article]] on this wiki for how to configure Adobe Sign e-signature documents.
 
  
 
==Retrieving Integration Keys==
 
==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 call is made and will not resolve directly on the source of a page. This prevents exposing the credentials to the end user.
+
Integration keys can be retrieved from the Variable Processor via the following syntax. The ssGet variables will only get replaced when the 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)@ returns the username from the "keyname" entry
+
@ssGet(APIKEY,''keyname'',''attribute'')@
−
@ssGet(APIKEY,keyname,password)@ returns the password from the "keyname" entry
 
  
−
Example call:
+
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 - the url to post the restful call to
+
<pre>//service call syntax:
−
fields - contain all the parameters you may need (required is "svc=restful")
+
//exservice_call(syncflag, callbackfunc, fields, URL)
 +
//URL - the URL to post the call to.
 +
//fields - contain all the parameters you may need (required is "svc=restful"), delimited by ';;'.
  
−
exservice_call(false,"","svc=restful;;username=@ssGet(APIKEY,keyname,username)@ ;;password=@ssGet(APIKEY,keyname,password)@ ","http://api.com/")
+
//given an Integration Key named 'myapi'
 +
exservice_call(false, "", "svc=restful;;companyid=xxx;;alias=xxx;;username=@ssGet(APIKEY,myapi,username)@;;password=@ssGet(APIKEY,myapi,password)@;;apitoken=xxx;;reportid=xxx", "https://smart.smartsimple.com.com/API/1/report/")
 
</pre>
 
</pre>
  
 
[[Category:Integration]] [[Category:System Integration]]
 
[[Category:Integration]] [[Category:System Integration]]

Latest revision as of 14:51, 13 July 2023

Overview

SmartSimple allows for the ability to store the authentication credentials for various integration end points 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 with services such as Salesforce, and Adobe Acrobat Sign, as well any custom end point.

Configuring Integration Keys

You need to have Global User Administrator permissions in order to access Integration key functions.

  1. Within SmartSimple, access the Global Settings page.
  2. Click on the Integrations tab and under Services Settings, click on Integration Key Management link.
  3. This page will list all current integration keys configured for this instance of SmartSimple.
  4. Create a new Integration Key by clicking the + button on the top left. 
  5. Select a Key Type, fill out the authentication details and click Save once complete.

Integration Key-1.PNG

Function Settings

Each new integration key has the following fields below.

KeyTypes.png

  • Name - Unique name description for this integration key.
  • Security Token - Access token or integration key from the external service.
  • Authentication URL - end point of external service.
  • Synchronization Direction 
    • From SmartSimple to External Service 
    • From External Service to SmartSimple 
    • Bidirectional
  • Username - Username of API account
  • 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. See the Adobe Acrobat Sign article on this wiki for how to configure Adobe Acrobat 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 call is made and will not resolve directly on the source of a page. This prevents exposing the credentials to the end user. 

@ssGet(APIKEY,keyname,attribute)@

An example use of this would be using the built in service call function to make a RESTful API call 

//service call syntax:
//exservice_call(syncflag, callbackfunc, fields, URL)
//URL - the URL to post the call to.
//fields - contain all the parameters you may need (required is "svc=restful"), delimited by ';;'.

//given an Integration Key named 'myapi'
exservice_call(false, "", "svc=restful;;companyid=xxx;;alias=xxx;;username=@ssGet(APIKEY,myapi,username)@;;password=@ssGet(APIKEY,myapi,password)@;;apitoken=xxx;;reportid=xxx", "https://smart.smartsimple.com.com/API/1/report/")
Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Integration_Key_Management&oldid=41572’