v5 Migration Guide - REST
- Former user (Deleted)
REST API /v1 and /v2 have been deactivated on DEMO environment already; and will be deactivated on the Shared-SaaS Production environments in February 2022. Also on Private-SaaS and On-Premise environments with 21.52 release on, the old /v1 and /v2 endpoint will not be accessible any more. Note that even if the /v3, /v4 and /v5 remain valid for some time (no date communicated yet to discontinue any of those); we recommend to use the /v5 API specification. The examples below may refer to the /v3 or /v4 endpoint; but there are just minor differences to the recommended /v5 API specification.
As some of our REST API versions have been declared deprecated, this Migration Guide leads you through the changes from REST API version 1.0 and 2.0 to 3.0 and 4.0. You can find all differences between those versions on this page as well as all calls which have not changed and which can be used like in older versions.
Following two versions of API REST are deprecated:
- version v1.0
- version v2.0
You can find all available version here: https://demo.esignanywhere.net/Api
Changes From v1.0 to v4.0
In this section you can find all changes if you switch from version 1.0 to version 4.0. In addition to all changes listed below the URI changes from https://demo.esignanywhere.net/Api/v1.0/##method## to https://demo.esignanywhere.net/Api/v4.0/##method##.
Correction of the mistyped keyword: HashAlgoritmIdentifier to HashAlgorithmIdentifier
This change affects the following api calls:
| Group | Api calls |
|---|---|
| envelope | envelope/create |
| envelope/prepare (also in the response) | |
| envelope/send |
SendEnvelopeBulkResult has been changed to SendEnvelopeResult and within this tag the keyword EnvelopeIds has been changed to BulkChildrenIds and the keyword BulkId changed to EnvelopeId.
This change affects the following api calls:
| Group | Api calls |
|---|---|
| envelope | envelope/send |
| envelope/sendFromTemplate |
Correction of the mistyped keyword AuthenticationMethodGenericOAutClient to AuthenticationMethodGenericOAuthClient.
Renaming of the keyword: “FlowApi” has been removed from all words where it occurs.
This change affects the following api calls:
| Group | Api calls |
|---|---|
| envelope | envelope/create |
| envelope/prepare (also in the response) | |
| envelope/send | |
| envelope/createFromTemplate | |
| envelope/sendFromTemplate | |
| user | user/create |
The section
"GeneralPolicies":
is in version 4.0 in the following section:
"Policy": {
"GeneralPolicies": {
The section:
"AuthenticationMethods": {
"AuthenticationMethods": [
{
is in version 4.0:
"AuthenticationMethods": {
"AuthenticationMethodList": [
{
Those two changes affects the following api calls:
| Group | Api calls |
|---|---|
| envelope | envelope/prepare (also in the response) |
| envelope/send |
Envelope reminder has more information in the response (added the following two lines):
"AvoidedDueToRateLimitCount": 0, "AvoidedDueToDisabledEmailCount": 0
Same Api calls From v1.0 to v4.0
There were no changes from version 1.0 to 4.0 in the following api calls:
| Group | Api calls |
|---|---|
| envelope | envelope/cancel |
| envelope/{envelopeId} (delete) | |
| envelope/find | |
| envelope/downloadCompletedDocument/{documentId} | |
| envelope/{envelopeId}/downloadPageImage/{docRefNumber}/{pageNumber} | |
| envelope/{envelopeId}restart/{expirationInDays} | |
| recipient | recipient/{recipientId}/fromEnvelopeId} (delete) |
| SspFile | sspfile/disposablefile/{sspFileId} |
| sspfile/uploadtemporary | |
| team | team (get) |
| team (post) | |
| user | user/{userId} (delete) |
| user/{userId} (patch) | |
| user/find | |
| user/{userId}/uploadSignatureImage |
Also the two api calls “authorization” and “version” stayed the same.
New Api calls From v1.0 to v4.0
| Group | Api calls |
|---|---|
| envelope | envelope/{templateId}/copyFromTemplate |
| envelope/{envelopeId}/unlock | |
| license | license |
| user | user/{email} |
Changes From v2.0 to v4.0
In this section you can find all changes if you switch from version 2.0 to version 4.0. In addition to all changes listed below the URI changes from https://demo.esignanywhere.net/Api/v2.0/##method## to https://demo.esignanywhere.net/Api/v4.0/##method##.
Correction of the mistyped keyword: HashAlgoritmIdentifier to HashAlgorithmIdentifier
This change affects the following api calls:
| Group | Api calls |
|---|---|
| envelope | envelope/create |
| envelope/{envelopeId} (get) | |
| envelope/prepare (also in the response) | |
| envelope/send | |
| envelope/{templateId}/copyFromTemplate | |
| recipient | recipient/{recipientId}/fromEnvelope/{envelopeId} |
SendEnvelopeBulkResult has been changed to SendEnvelopeResult and within this tag the keyword EnvelopeIds has been changed to BulkChildrenIds and the keyword BulkId changed to EnvelopeId.
This change affects the following api calls:
| Group | Api calls |
|---|---|
| envelope | envelope/send |
| envelope/sendFromTemplate |
Correction of the mistyped keyword AuthenticationMethodGenericOAutClient to AuthenticationMethodGenericOAuthClient.
Envelope reminder has more information in the response (added two lines):
"AvoidedDueToRateLimitCount": 0, "AvoidedDueToDisabledEmailCount": 0
Same Api calls From v2.0 to v4.0
There were no changes from version 2.0 to 4.0 in the following api calls:
| Group | Api calls |
|---|---|
| envelope | envelope/cancel |
| envelope/{envelopeId} (delete) | |
| envelope/find | |
| envelope/downloadCompletedDocument/{documentId} | |
| envelope/{envelopeId}/downloadPageImage/{docRefNumber}/{pageNumber} | |
| envelope/{envelopeId}restart/{expirationInDays} | |
| recipient | recipient/{recipientId}/fromEnvelopeId} (delete) |
| SspFile | sspfile/disposablefile/{sspFileId} |
| sspfile/uploadtemporary | |
| team | team (get) |
| team (post) | |
| user | user/create |
| user/{userId} (delete) | |
| user/{userId} (patch) | |
| user/find | |
| user/{userId}/uploadSignatureImage | |
| user/{email} |
Also the two api calls “authorization” and “version” stayed the same.
New Api calls From v2.0 to v4.0
| Group | Api calls |
|---|---|
| envelope | envelope/{envelopeId}/unlock |
| license | license |
Changes From v3.0 to v4.0
In this section you can find all changes if you switch from version 3.0 to version 4.0. In addition to all changes listed below the URI changes from https://demo.esignanywhere.net/Api/v3.0/##method## to https://demo.esignanywhere.net/Api/v4.0/##method##.
Same changes as in version 2.0 only the following two changes do not apply to version 3.0 because those changes are already the same in version 3.0 as in version 4.0:
"AvoidedDueToRateLimitCount": 0, "AvoidedDueToDisabledEmailCount": 0
SendEnvelopeBulkResult is already the keyword SendEnvelopeResult and within this tag the keyword EnvelopeIds is already renamed to BulkChildrenIds as well as BulkId is already renamed to EnvelopeId.
Different eSAW versions with api version 4.0
Here you can find a list (JSON files) of different eSignAnyWhere versions with api version 4.0.
Only those versions are listed below which are actually supporting version 4.0 (starting with eSignAnyWhere version 3.4)
eSignAnyWhere version | JSON file |
|---|---|
| 3.4.125.13343 | swagger-v4.0-3.4.125.13343.zip |
| 3.5.46.13340 | swagger-v4.0-3.5.46.13340.zip |
| 3.6.74.14357 | |
| 3.7.95.15158 | swagger-v4.0-3.7.95.15158.zip |
| 20.14.0.15478 | swagger-v4.0-20.14.0.15478.zip |
| 21.31 | See https://demo.esignanywhere.net/Api; using the /v5 API is recommended |
| 19.76.0.15531 | swagger-v4.0-19.76.0.15531.zip |
| 20.76 ("21 LTS") | See demo-lts.esignanywhere.net/api/; using the /v5 API is recommended |