How to integrate Adobe Sign with Sapho version 4.9 or greater
Category: Integration Setup
Sapho requires regular API access to your Adobe Sign instance. In order to accomplish this, we recommend creating a dedicated user account (for example, firstname.lastname@example.org) in Adobe Sign and then using that account to configure the Adobe Sign integration in Sapho. This account should:
- Have full data access privileges
- Be API-enabled
Using a dedicated account is particularly useful for audit logs as it helps distinguish activities done through Sapho.
Note: You will need the Adobe Sign Enterprise Plan in order to have full access to the API.
Create an Application
To use Adobe Sign APIs, you will need to create an application first.
Adobe Sign uses the OAuth authentication protocol to authorize requests for any Sign API endpoint. So, you will need to get the Application ID and Application Secret from the web UI of Adobe Sign. To do this, please follow the steps below:
- Log into Adobe Sign.
- Click API. If you are already an Adobe Sign Enterprise customer, you may not see the API link. If that is the case, click Account to proceed.
- Click API Applications.
- Click Create and provide details about your app.
When you create a new app, you need to choose the right domain:
- CUSTOMER - Apps for internal use and testing.
(Select this domain if you need your app to only access data from your account.)
- PARTNER - Apps for production and public use.
(Select this domain if you need your app to access data in any Adobe Sign account.)
In the previous section , you learned how to create an application in Adobe Sign. Next, you will need to configure OAuth for your application so that the client-side applications that you build can use Adobe Sign APIs.
- Click View/Edit above the newly created Application to get your Application ID and Secret. Copy and paste your app's Application ID and Secret somewhere you can access later on. You will use this information to issue access tokens in the Adobe Sign API.
- Click Configure OAuth for Application to enable scopes.
- Enable the Scopes that you intend to request through the OAuth protocol. Please note: Only Group Admins can approve OAuth requests that use the “group” scope modifier, and only Account Admins can approve OAuth requests that use the “account” scope modifier.
NOTE: It is recommended to give full "account" accesses to the API Aplication used to integrate with Sapho.
The following modifiers are available:
Click Save. You are now ready to use Sign APIs from your client-side apps. OAuth is widely used by developers to authorize API access, and Adobe Sign's implementation complies with the OAuth 2.0 specification.
The OAuth process requires users of your apps to grant permissions before invoking any API.
NOTE: Before you begin using Sign APIs, we recommend reading Using OAuth to Access Adobe Sign APIs.
The last piece of the setup in Adobe Sign is the Webhook configuration. This configuration is important, as it allows to keep the data in Sapho up to date. Each time an agreement gets approved or rejected, Adobe will automatically send a notification to Sapho and trigger an incremental sync.
To properly configure the Adobe Sign Webhook, please follow the steps below:
- Click the “+” icon in the Webhooks section
- Fill in the following details for the new webhook:
- Name - the name of your webhook
- Scope - Select Account as your scope
- URL - https://”YourSaphoUrl”/external-services/com.sapho.services.adobe.sign.AdobeSignService/webhook
- Events - Go to Agreement and then select Agreement all events
- Notification Parameters - check the Agreement Info option
- Click Save
NOTE: For more information about Adobe Sign Webhooks, please consult Adobe Sign’s documentation.
Integration setup in Sapho
- Log into Sapho Builder (Admin).
- Go to the Data or Micro Apps page and start the Add Adobe Sign Integration or Add Adobe Sign Micro App wizard by clicking on the Adobe Sign icon.
- Enter the URL of your instance. The Instance URL is the domain in which your Adobe Sign instance resides.
- Enter the Client Id and Client Secret that you saved when you were configuring OAuth.
- On the next screen click on “LOG IN WITH YOUR ADOBE SIGN ACCOUNT”, you will be redirected to the Adobe Sign login page. Enter your standard login details (email and password).
- Click Next to finish creating the integration.