| Info | ||
|---|---|---|
| ||
Please note that this documentation and the links refer to the api v6. For more information please see the migration guide and the documentation and the links refer to the api v6. For more information please see the migration guide and the documentation related to v5related to v5. |
| Info |
|---|
REST API /v3 and /v4 DEPRECATION: The 23.76 (published March 2024) will be the last LTS version that includes these API versions. By early June 2024, the REST API routes to v3/v4 will be deactivated on DEMO. Early December 2024, the REST API routes to v3/v4 will be removed from feature stream releases. Note that there is no date communicated yet to discontinue REST APIv5 (and where v5 refers to v4 routes, these will still remain); however we recommend to use the /v6 API specification already. |
Introduction
On this page you will find the eSAW API description. First we start with a basic overview of the API. If you are looking for examples we recommend the Postman Sample, Envelope structure and our Stories and Examples.
| Table of Contents | ||
|---|---|---|
|
...
The easiest way to start is enabling the DeveloperMode for a user. As developer (and power user) you can send envelopes via eSignAnywhere in the UI and download the complete envelope configuration (including the workstep configurations). So eSAW can be a seen as configuration designer, where you can easily prepare the envelope configuration. After you downloaded the configuration you just have to replace the recipient information and configuration.
...
| REST API Reference (Swagger) | >= 3.1 | | https://demo.esignanywhere.net/Api |
| REST tutorials | This turorials help getting familiar with the API technology and the most common tools to do first tests of API calls already before implementing your own integration code. visit REST tutorial using Postman |
| Tutorial: Hello World* | This tutorial allows to dig into the API integration of eSignAnyWhere a bit deeper. It focuses on audience already familiar with tools to run API calls, such as Postman or SoapUI. |
| Developer mode* | visit developer mode |
| Sample Code in Java | Here you can find the java sample: Download. (Contains example with REST, developed with JavaSE-12) |
| visit SignAnyWhere Viewer 2019 Information | |
| SignAnyWhere Viewer Extended Customization | visit SignAnyWhere Viewer Extended Customization |
| Integration & Use Cases | visit Integration & Use Cases |
| Developer FAQ | visit Developer FAQ |
| eSAW Error Codes | visit eSAW Error Codes |
* Recommended
The User Guide, Signer Guide and Administration Guide (for on-premise customers) can be also helpful.
...
We recommend to use user-specific API tokens. Therefore, each user can create several tokens for different application integrations. The apiToken has to be provided as HTTP Header. 
Please see the next sample authorization (Bearer token):
| Key | Value |
|---|---|
| "Authorization" | e.g. "Bearer asdfngtmvv8pfmsuaxpzz85zux3e63dd9zttrwitx9mln6qka6tds83du3p3lroe" |
Please see the next sample authorization (api token):
| Key | Value |
|---|---|
| "ApiToken" | "asdfngtmvv8pfmsuaxpzz85zux3e63dd9zttrwitx9mln6qka6tds83du3p3lroe" |
...
Consider, that our system expects the full callback url, including the parameter list you expect, with the placeholders that should be replaced by values at runtime. You can also add your own paramter parameter for that envelope (e.g. internal references). Moreover, on our shared SaaS environments only HTTPS callbacks (port 443, and 1025-65535) callbacks are allowed.
Placehoder for callback URL:
...
Consider, that our system expects the full callback url, including the parameter list you expect, with the placeholders that should be replaced by values at runtime. You can also add your own paramter parameter for that envelope (e.g. internal references). Moreover, on our shared SaaS environments only HTTPS callbacks (port 443, and 1025-65535) callbacks are allowed.
Sample:
https://www.mycallback.at?envelope=##EnvelopeId##&action=##Action##
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<callbackProxySettings>\n < <!-- Enable or disable the use of proxy for all callbacks. Values 1 (enabled) or 0 (disabled)-->\n <enabled>0< <enabled>0</enabled>\n < <!-- Address of the proxy server-->\n <address>< <address></address>\n < <!-- Send all callbacks to local addresses without using proxy. Values 1 (bypass for local) or 0 (always use proxy)-->\n < <!-- Local requests are identified by the lack of a period (.) in the URI, as in http://webserver/, or access the local server, including http://localhost, http://loopback, or http://127.0.0.1-->\n <bypassProxyOnLocal>0< <bypassProxyOnLocal>0</bypassProxyOnLocal>\n <networkCredentials>\n < <networkCredentials> <!-- Domain for Credentials-->\n <domain>< <domain></domain>\n < <!-- Username for Credentials-->\n <username>< <username></username>\n < <!-- Password for Credentials. If password is not encrypted then remove the attribute enc-->\n <password <password enc="sec2"></password>\n < </networkCredentials>\n < </callbackProxySettings> |
The following placeholders are defined:
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
"CallbackConfiguration": {\n
"CallbackUrl": "string",\n
"StatusUpdateCallbackUrl": "string",\n
"StepActionCallbackConfigurationActivityActionCallbackConfiguration": {\n
"Url": "string",\n
"ActionCallbackSelection": {\n
"ConfirmTransactionCode": true,\n
"DefaultEventType": true,\n
"AgreementAccepted": true,\n
"AgreementRejected": true,\n
"RequestPrepareAuthenticationInformationSuccess": true,\n
"PrepareAuthenticationSuccess": true,\n
"AuthenticationFailed": true,\n
"AuthenticationRejected": true,\n
"AuthenticationSuccess": true,\n
"ReAuthenticationFailed": true,\n
"AuditTrailRequested": true,\n
"AuditTrailXmlRequested": true,\n
"CalledPage": true,\n
"WhoIsInformation": true,\n
"DocumentDownloaded": true,\n
"FlattenedDocumentDownloaded": true,\n
"AddedAnnotation": true,\n
"AddedAttachment": true,\n
"AppendedDocument": true,\n
"FormsFilled": true,\n
"ConfirmReading": true,\n
"PageViewChanged": true,\n
"SendTransactionCode": true,\n
"PrepareSignWorkstepDocument": true,\n
"SignWorkstepDocument": true,\n
"UndoAction": true,\n
"WorkstepCreated": true,\n
"WorkstepFinished": true,\n
"WorkstepRejected": true,\n
"DisablePolicyAndValidityChecks": true,\n
"EnablePolicyAndValidityChecks": true,\n
"AppendFileToWorkstep": true,\n
"AppendTasksToWorkstep": true,\n
"SetOptionalDocumentState": true,\n
"PreparePayloadForBatch": true\n
}\n
}\n
}, |
Please note that if all event types are disabled the URL which was configured in the configuration will not get any callbacks.
...