This guide shows you all changes you have to take into account when you switch from a SOAP integration to a REST integration.
First the endpoints are different
Two SOAP endpoints: https://demo.esignanywhere.net/api.asmx?WSDL
https://demo.esignanywhere.net/UserManagementApi.asmx?WSDL
One REST endpoint (base URI):
You can find the latest version here: https://demo.esignanywhere.net/Api
The names of the api calls are different:
Authorization
| SOAP | REST |
|---|---|
| ValidateAuthorization_v1*** | authorization |
Envelope
| SOAP | REST |
|---|---|
| CreateDraft_v1* | envelope/create |
| CreateDraftFromTemplate_v1* | envelope/createFromTemplate |
| CancelEnvelope_v1* | envelope/{envelopeId}/cancel |
| GetEnvelopeById_v1* | envelope/{envelopeId} (get) |
| DeleteEnvelope_v1* | envelope/{envelopeId} (delete) |
| FindEnvelopes_v1* or FindEnvelopes_v2* | envelope/find |
| DownloadCompletedDocument_v1* | envelope/downloadCompletedDocument/{documentId} |
| DownloadEnvelopePageImage_v1* | envelope/{envelopeId}/downloadPageImage/{docRefNumber}/{pageNumber} |
| PrepareSendEnvelopeSteps_v1* | envelope/prepare |
| RestartEnvelope_v1* | envelope/{envelopeId}/restart/{expirationInDays} |
| SendEnvelope_v1* | envelope/send |
| SendEnvelopeFromTemplate_v1* | envelope/sendFromTemplate |
| SendReminders_v1* | envelope/{envelopeId}/remind |
| CopyDocumentFromTemplate_v1* | envelope/{templateId}/copyFromTemplate |
| UnlockEnvelope_v1* | envelope/{envelopeId}/unlock |
License
| SOAP | REST |
|---|---|
| GetLicenseState_v1* | license |
Recipient
| SOAP | REST |
|---|---|
| ReplaceRecipient_v1* | recipient/{recipientId}/fromEnvelope/{envelopeId} (put) |
| DeleteRecipient_v1* | recipient/{recipientId}/fromEnvelope/{envelopeId} (delete) |
SspFile
| SOAP | REST |
|---|---|
| DisposeSspFile_v1* | sspfile/disposefile/{sspFileId} |
| UploadTemporarySspFile_v1* | sspfile/uploadtemporary |
Team
| SOAP | REST |
|---|---|
| GetTeams_v1** | team (get) |
| SetTeams_v1** | team (post) |
User
| SOAP | REST |
|---|---|
| CreateUser_v1** | user/create |
| DeleteUser_v1** | user/{userId} (delete) |
| UpdateUser_v1** | user/{userId} (patch) |
| FindUsers_v1** or FindUsers_v2** | user/find |
| user/{userId}/uploadSignatureImage | |
| GetUserByEmail_v1** | user/{email} |
Version
| SOAP | REST |
|---|---|
| GetVersion_v1 *** | version |
* api calls from the following endpoint: https://demo.esignanywhere.net/api.asmx?WSDL
** api calls from the following endpoint: https://demo.esignanywhere.net/UserManagementApi.asmx?WSDL
*** api calls which are offered by both endpoints
Api calls which are only available with SOAP:
- GetAdHocWorkstepConfiguration_v1
- NotifyEnvelopeWorkstepIsCompleted_v1
- UploadUserFile
Api calls which are only available with REST:
- user/{userId}/uploadSignatureImage