Versions Compared

Old Version 7

changes.mady.by.user Unknown User (bimminger)

Saved on

compared with

New Version Current

changes.mady.by.user Manuel Gierlinger

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


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.


Info

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.

...

Table of Contents
maxLevel4
stylecircle

Section

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:

...

Code Block
languagejava
themeEclipse
"AvoidedDueToRateLimitCount": 0,
"AvoidedDueToDisabledEmailCount": 0


Section

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:

GroupApi calls
envelopeenvelope/cancel

envelope/{envelopeId} (delete)

envelope/find

envelope/downloadCompletedDocument/{documentId}

envelope/{envelopeId}/downloadPageImage/{docRefNumber}/{pageNumber}

envelope/{envelopeId}restart/{expirationInDays}
recipientrecipient/{recipientId}/fromEnvelopeId} (delete)
SspFilesspfile/disposablefile/{sspFileId}

sspfile/uploadtemporary
teamteam (get)

team (post)
useruser/{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

GroupApi calls
envelopeenvelope/{templateId}/copyFromTemplate

envelope/{envelopeId}/unlock
licenselicense
useruser/{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:

GroupApi calls
envelopeenvelope/create

envelope/{envelopeId} (get)

envelope/prepare (also in the response)

envelope/send

envelope/{templateId}/copyFromTemplate
recipientrecipient/{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:

GroupApi calls
envelopeenvelope/send

envelope/sendFromTemplate

Correction of the mistyped keyword AuthenticationMethodGenericOAutClient to AuthenticationMethodGenericOAuthClient.

Envelope reminder has more information in the response (added two lines):

...

Code Block
languagejava
themeEclipse
"AvoidedDueToRateLimitCount": 0,
"AvoidedDueToDisabledEmailCount": 0


Section

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:

...

Section


GroupApi calls
envelopeenvelope/cancel

envelope/{envelopeId} (delete)

envelope/find

envelope/downloadCompletedDocument/{documentId}

envelope/{envelopeId}/downloadPageImage/{docRefNumber}/{pageNumber}

envelope/{envelopeId}restart/{expirationInDays}
recipientrecipient/{recipientId}/fromEnvelopeId} (delete)
SspFilesspfile/disposablefile/{sspFileId}

sspfile/uploadtemporary
teamteam (get)

team (post)
useruser/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

GroupApi calls
envelopeenvelope/{envelopeId}/unlock
licenselicense

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:

...

Section

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.

REST API prior v4.0

JSON API definitions exported on eSAW 19.76.8



eSAW 19.76.8.19037 REST API v1.0

19_76 REST API v1.0.json

eSAW 19.76.8.19037 REST API v2.0

19_76 REST API v2.0.json

eSAW 19.76.8.19037 REST API v3.0

19_76 REST API v3.0.json

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.

...

Section


15478201415478.zip

eSignAnyWhere version

JSON file

3.4.125.13343swagger-v4.0-3.4.125.13343.zip
3.5.46.13340swagger-v4.0-3.5.46.13340.zip
3.6.74.14357

swagger-v4.0-3.6.74.14357.zip

3.7.95.15158swagger-v4.0-3.7.95.15158.zip
1920.7614.0.1553115478swagger-v4.0-1920.7614.0.1553115478.zip20.14
21.31See https://demo.esignanywhere.net/Api; using the /v5 API is recommended
19.76.0.15531swagger-v4.0-19.76.0.15531.zip
20.76 ("21 LTS")See demo-lts.esignanywhere.net/api/; using the /v5 API is recommended