Migrating and Updating Apps
Last update: Feb 06, 2024.
Updating API authentication methods
Adobe is committed to providing a safe and secure product experience for our customers by adhering to the latest industry-standard security protocols. As a part of that process, on December 2021, Adobe Acrobat Sign ended support for older API authentication models that allowed sending a username and password in the API call.
To move to a secure authentication model:
- Use REST APIs: Acrobat Sign APIs are now restricted to REST APIs. You can try out the REST API here.
- Use OAuth: To enable an end user to use your client app with Acrobat Sign, have the end-user authenticate with Adobe. The recommended way for authenticating end users with Acrobat Sign is the standard OAuth protocol.
The general recommendation is that every user in the organization should directly authenticate with Adobe while using your client app to have their unique access tokens issued. SAML configuration with Acrobat Sign in your user’s organization provides an easy way to do so. However, there might be enterprise use-cases where only a single admin is required to authenticate with Adobe and other users in this organization can just use the client without an Adobe login. This is possible via Adobe’s OAUTH modifiers. Modifiers enable clients to call APIs with admins’ OAUTH token and actual regular user’s identity in “x-api-user” header.
Migrating From SOAP
Applications using the legacy Acrobat Sign SOAP APIs should migrate to the more functional and secure v6 REST APIs.
SOAP to REST mapping
The tables below maps SOAP endpoints to their REST equivalents. Both endpoints link directly to the full method description.
General-purpose Methods
data-slots=text
GET /baseUris endpoint.Document Methods
SenderInfo is represented through x-api-user. Files are specified through /transientDocuments.
From v6 onwards, the interactive views can be specified and obtained from the POST /agreements/{agrId}/views endpoint for the interactive behavior.
MegaSign allows sending the same agreement to multiple recipients and creating a separate instance of agreement for each recipient.
From v6 onwards, the interactive views can be specified and obtained from the POST /agreements/{agrId}/views endpoint for the interactive behavior.
To delete the documents of agreements, use the DELETE /agreements/{agrId}/documents endpoint; and to remove it from Manage Page(GET /agreements), use PUT /agreements/\{agrId\}/visibility
Cancel: Called by sender.
Reject: Called by current signer.
Replace: Called by sender. Both the original signer and new one can sign.
Delegate: Called by signer. Both the delegator and delegatee can sign.
Status Methods
In SOAP API, getDocumentInfo, getDocuments, getAuditTrail etc. work on documentKeys, which can be an ID for an agreement, widget, or library document. The REST API demarcates these as separate resources (cleaner design and strongly typed) and hence, based on the kind of resource you are working on, there is a corresponding /libraryDocuments, /widgets to these. Example: /widgets/{widgetId}, GET will getDocumentInfo for widgetId, and similarly for documents, audit trail, etc.
externalId can be used to map your internal IDs to Acrobat Sign IDs.
REST returns a list of document IDs that can be provided to the following endpoint to get a document stream.
Retrieve the URL of the combined document.
Retrieve the URL of an individual document.
Retrieve the image URLs of all visible pages of an agreement.
Retrieve image URLs of a specified documentID.
Can also specify the content format.
Returns a CSV file stream.
User Methods
The REST equivalent can be used to see if the user exists, but does not support password verification.
Use the name = DOCUMENT to get the embedded view of an agreement.
Use x-api-user for specifying the user whose agreements are to be retrieved.
Use x-api-user for specifying the user whose library documents are to be retrieved.
Use x-api-user for specifying the user whose widgets are to be retrieved.
Get all child agreement IDs of the parent MegaSign.
Specify the new groupId in the request.
Web Form Methods
Use PersonalizedSigningViewConfiguration for specifying personalization options
Use PersonalizedSigningViewConfiguration for specifying personalization options
Use status value as INACTIVE.
Use status value as ACTIVE.
Test Methods
Deprecated SOAP methods
Access Methods
issueAccessToken - Auth has replaced access tokens.
Doc Methods
Status Methods
User Methods
© Copyright 2023, Adobe Inc.. Last update: Feb 06, 2022.
