| 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 related to v5. |
...
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 |
|---|
...
- Authorization
- UserKey Header Authorization
- Bearer token Authorization
- OrganizationKey and UserLogin Header
...
|
Overview and references
The API is for developers, who want to integrate eSignAnyWhere into their application and for administrators, who want to script interactions with eSignAnyWhere (e.g. user synchronization).
...
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" |
...
In general, our REST endpoint returns different HTTP status codes:
| Status Code | Description | Example |
|---|---|---|
| 200 | Request has been processed successfully. | Envelope has been deleted |
| 400 | The request cannot be processed. | Missing required value |
| 401 | Required Authorization has not been successful | API Token is expired, user is not active |
| 403 | Authorization is provided and valid, but the called method requires additional permissions | User does not have required permissions (Roles and Permissions) |
| 404 | Main resource for request could not be found or is not accessible | EnvelopeId is not known |
| 500 | Generic server errors | Depending Service is not available |