Difference between revisions of "Integration Key Management"

From SmartWiki
Jump to: navigation, search
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 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.
 
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=
+
==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.
 
# Log-in to SmartSimple and 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.
 +
 +
 +
[[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.
  
Line 35: Line 36:
 
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.
 
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=
+
===Retrieving Integration Keys===
 
[[Category:Integration]] [[Category:System Integration]]
 
[[Category:Integration]] [[Category:System Integration]]

Revision as of 14:49, 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.


Integration Key-1.PNG


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 Adobe Sign for how to configure Adobe Sign e-signature documents.

Retrieving Integration Keys