Difference between revisions of "Integration Key Management"

Revision as of 14:24, 22 September 2017

Overview

SmartSimple allows for the ability to store multiple authentication credentials and integration end points to perform RESTful API calls to external services.

Features include native integration for Salesforce and Adobe Sign, with custom integrations available capable of transferring the integration key to other systems for authentication.

Configuring Integration Keys

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

1. Log-in to SmartSimple and 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.

Function Settings

Each new integration key has the following fields below.

• Key Type
  • Custom
  • Adobe Sign
  • Salesforce
• Key Name - Unique name description for this integration key
• Authentication URL - Integration End Point of external service
• Security Token - Access token or integration key from the 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 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 Sign article on this wiki 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 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,username)@ returns the username from the "keyname" entry
@ssGet(APIKEY,keyname,password)@ returns the password from the "keyname" entry

Example call:
exservice_call(flag ,callbackfunc,fields,url)

url - the url to post the restful call to
fields - contain all the parameters you may need (required is "svc=restful")

exservice_call(false,"","svc=restful;;username=@ssGet(APIKEY,keyname,username)@ ;;password=@ssGet(APIKEY,keyname,password)@ ","http://api.com/")