Developer Account
This account will allow you unlimited transactions for end-to-end testing of your workflow using the API, with the following caveats:
- There is a watermark on every agreement sent (This should not be an issue since you’re testing the ability to send, sign and/or download agreements).
- The use of KBA/Phone authentication is limited to 5 (This should allow you enough repetitions to understand behavior. Best practice to perform this testing last).
- You cannot have an e-mail address in more than one instance so it is recommended that you use a non-production e-mail address
More on API's
Which Authentication?
Auth
- An "application" sending agreements on behalf of many users
- All senders must have a user account for authentication
- User account must be in ACTIVE status
- Access token created when the user authenticates (logs into) the application
- Scopes defined by the application
- Code to manage the token expiration process is required
OAuth API documentation
https://secure.echosign.com/public/static/oauthDoc.jsp
https://www.es-ps.com/es_oauth/index.php
Integration Key
- An "application" sending all agreements using a single user account, or on behalf of many users
- Should be used for an internal applications only
- Created by an account admin or group admin with specific scopes defined by admin
- Does not expire until revoked or the account that created it is deactivated
Tip: You can use an integration key as an access token.
How to create an Integration Key
https://helpx.adobe.com/sign/kb/how-to-create-an-integration-key.html
Note: If the link is not visible on your account, you can ask Support to enable it.
v6 Enhancements (ETAGS, creating agreements in draft status, webhooks, etc)
Webhooks Documentation (push notifications - v6 only):
https://www.adobe.io/apis/documentcloud/sign/docs/#!adobedocs/adobe-sign/master/webhooks.md
Events API documentation (keeping track of events within your app)
https://www.adobe.io/apis/documentcloud/sign/docs/#!adobedocs/adobe-sign/master/events.md
Simple Workflow Step by Step on Developer Portal
OR
Sample API workflow:
Upload a document
Make a temporary file available to use in sending an agreement: POST /transientDocuments
Result is: transientDocumentId
OR
Create a library document (template) to repeatedly send as an agreement: POST /libraryDocuments
Result is: libraryDocumentId
· Generate the transaction
Send an agreement for signature supplying the recipients, documents, other required details: POST /agreements
Result is: agreementId
· Present the agreement for signature
Obtain the URL(s) for the signature: GET /agreements/{agreementId}/signingUrls
Tip: Add &noChrome=true to the end of the URL to remove the branding.
· Retrieve the status of the agreement
Track document status, participant and event information: GET /agreements/{agreementId}
OR
· Retrieve the agreement after signature
Retrieve the combined files of an agreement after signature (base64):
GET /agreements/{agreementId}/combinedDocument
OR
Retrieve the combined files of an agreement after signature (URL)
GET /agreements/{agreementId}/combinedDocument/url
OR
Retrieve the individual files of an agreement after signature
GET /agreements/{agreementId}/documents (obtains the id info needed for next call)
GET /agreements/{agreementId}/documents/{documentId}
(retrieves the individual document)
· Retrieve the form data after signature:
Obtain the form data: GET /agreements/{agreementId}/formData
API Change log
V6 Postman documentation
https://documenter.getpostman.com/view/14752/RWEnmFPv
V6 Postman collection