...
Some other interesting documentation links:
...
The tutorial will show you the following basic use-case:
Hello World
Before starting with the first request please note the following:
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"Documents": [{
"FileId": "83467fdcd33d43ca-1234-45921234-1234-9c64787cd7a1b645fc4e0fb2",
"DocumentNumber": 1
}
],
"Name": "Test",
"Activities": [{
"Action": {
"Sign": {
"RecipientConfiguration": {
"ContactInformation": {
"Email": "janedoe@samplejane.doe@sample.com",
"GivenName": "Jane",
"Surname": "Doe",
"LanguageCode": "EN"
}
},
"Elements": {
"Signatures": [{
"TaskConfigurationElementId": {
"sample sig click2sign",
"OrderDefinitionRequired": {true,
"OrderIndex"DocumentNumber": 01,
"DisplayName": "Sign here",
}
"AllowedSignatureTypes": },
{
"IdClickToSign": "sample{
sig click2sign",
"Required": true, }
"DocumentNumber": 1},
"DisplayNameFieldDefinition": "Sign here",
{
"AllowedSignatureTypesPosition": {
"ClickToSignPageNumber": {1,
}
"X": 100,
},
"Y": 200
"FieldDefinition": {
},
"Position": {
"Size": {
"PageNumber": 1,
"Width": 100,
"X": 100,
"Height": 70
"Y": 200
}
},
}
"Size": {}
]
"Width": 100,
}
}
}
"Height": 70}, {
"Action": {
"SendCopy": {
}
"RecipientConfiguration": {
}
"ContactInformation": {
}
"Email": "john.doe@sample.com",
]
"GivenName": "John",
},
"SigningGroupSurname": "firstSignerDoe",
}
}"LanguageCode": "EN"
}, {
"Action": {
"SendCopy": {}
"RecipientConfiguration": {}
"ContactInformation": {}
}
}
]
} |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{ "EmailEnvelopeId": "johndoe@sample.com", "GivenName": "John", 45fd01ce-1234-4792-1234-f5230e41b130" } |
The envelope id is used for managing the envelopes (send reminder, cancel delete, reject envelope,…).
After the successful creation of the envelope, it is sent to the first recipient.
Open the envelope
After you have sent the envelope and you have got the envelopeId you can call the method https://demo.esignanywhere.net/api/v6/envelope/{envelopeId}/viewerlinks. With the result of this method you get information about the envelope and you can find the workstepRedirectionURL (Viewerlink).
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{ "ViewerLinks": [ "Surname": "Doe", "LanguageCode": "EN" } }{ "ActivityId": "5609d2ea-1234-1234-1234-1959e63fde64", } "Email": "john.doe@sample.com", } } ] } |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"EnvelopeId": "45fd01ce-1234-4792-1234-f5230e41b130"
} |
The envelope id is used for managing the envelopes (send reminder, cancel delete, reject envelope,…).
"ViewerLink": "https://demo.esignanywhere.net/workstepredirector/sign?identifier=mdIkzVC1234512IgiOLD3Iodfynd~12345RbJQXusyZuCNp7FR6PniOT12345B~fQ1234A=="
}
]
} |
With this redirection link it is possible to open and sign the document in your web portalAfter the successful creation of the envelope, it is sent to the first recipient.
Find the envelope
| Note |
|---|
| Authorization is required. |
...