How to integrate with Postman
Collection
In this tutorial you will do the first API call as well as sending envelopes, upload documents and download signed papers. Let us start with creating a collection so that we can save all requests there.
Figure | Steps |
---|
Image RemovedImage Added | Steps:- Go to register "new"
- Select "Collection"
|
...
After creating a new Collection, we will save our first request into it.
Figure | Description |
---|
Image RemovedImage Added | Steps:- Go to register "new"
- Select "request"
- Choose a name and save the request in the collection
|
...
Let us start now with the first API call. As the name of our request tells we will first make an easy call to examine the current version.
Image RemovedImage Added
...
Before we can send an envelope, we must make sure that we have already uploaded a file. Therefore, the next request will be about uploading a file.
Image RemovedImage Added
Figure | Description |
---|
Image RemovedImage Added | Steps:- Set the request type to POST
- Set the URI: https://demo.esignanywhere.net/Api/v6/file/upload
- Add a file in the section "Body" form-data
- Add the authentication (Api Token) in the header
Response Code Block |
---|
| {
"FileId": "8a4fd938-1234-1234-9866-f0fe466781d3"
} |
Please note: The FileId is needed for the next api call. |
...
and paste it in the body of the sending request. Then change from “none” to “raw” and change the File ID to the one you get from the upload file request.
Image RemovedImage Added
Figure | Description |
---|
Image RemovedImage Added | Steps:- Set the request type to POST
- Set the URI: https://demo.esignanywhere.net/Api/v6/envelope/send
- Add the envelope configuration in "Body" (sample configuration below)
- Please change the type to "raw"
- Change the "Text" to JSON format
- Add the authentication (Api Token) in the header
Response Code Block |
---|
| {
"EnvelopeId": "1393adcf-1234-1234-9173-aba385426549"
} |
Please note: The EnvelopeId is needed for the next api call. |
...
Code Block |
---|
|
{
"Documents": [
{
"FileId": "8a4fd938d33d43ca-1234-1234-842a1234-be1e1d472b1cb645fc4e0fb2",
"DocumentNumber": 1
}
],
"Name": "Test",
"Activities": [{
"Action": {
"Sign": {
"Action": {
"SignRecipientConfiguration": {
"RecipientConfigurationContactInformation": {
"ContactInformationEmail": {"jane.doe@sample.com",
"EmailGivenName": "janedoe@sample.comJane",
"GivenNameSurname": "JaneDoe",
"SurnameLanguageCode": "DoeEN"
}
},
"Elements": {
"Signatures": [{
{
"ElementId": "sample sig click2sign",
"TaskConfiguration": {
"OrderDefinition": {
"OrderIndex": 1
}
},
"ElementId": "sample sig click2sign""Required": true,
"RequiredDocumentNumber": true1,
"DocumentNumberDisplayName": "Sign 1here",
"DisplayNameAllowedSignatureTypes": {
"Sign here",
"AllowedSignatureTypesClickToSign": {
"ClickToSign": {}
},
"FieldDefinition": {
"Position": {
"PageNumber": 1,
"X": 100,
"Y": 200
},
"Size": {
"Width": 100,
"Height": 70
}
}
}
]
},
"SigningGroup": "firstSigner"
}
}
}, {
"Action": {
"ActionSendCopy": {
"SendCopyRecipientConfiguration": {
"RecipientConfigurationContactInformation": {
"ContactInformationEmail": {"john.doe@sample.com",
"EmailGivenName": "johndoe@sample.comJohn",
"GivenNameSurname": "JohnDoe",
"SurnameLanguageCode": "DoeEN"
}
}
}
}
}
]
} |
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).
Image RemovedImage Added
Image RemovedImage Added | Steps:- Set the request type to GET
- Set the URI: https://demo.esignanywhere.net/api/v6/envelope/{envelopeId}/viewerlinks
- Add the authentication (Api Token) in the header
Response Code Block |
---|
| {
"ViewerLinks": [
{
"ActivityId": "5609d2ea-1234-1234-1234-1959e63fde64",
"Email": "john.doe@sample.com",
"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 portal. |
Download the signed document
Before downloading the documents we need the file Ids. Therefore the following api call is necessary:
Image RemovedImage Added
Figure | Description |
---|
Image AddedImage Removed
| Steps:- Set the request type to GET
- Set the URI: https://demo.esignanywhere.net/Api/v6/envelope/{envelopeId}/files
- Add the authentication (Api Token) in the header
Response Code Block |
---|
| {
"Documents": [
{
"FileId": "78b271f2-1234-1234-1234-3799951b1d54",
"FileName": "Test.pdf",
"Attachments": [],
"PageCount": 1,
"DocumentNumber": 1
}
],
"AuditTrail": {
"FileId": "7a86456c-1234-1234-1234-032757afa88e",
"XmlFileId": "dc60dcd4-1234-1234-1234-8828c79a2c88"
},
"Disclaimers": []
} |
Here you can see all three Ids for the documents which can be downloaded. |
After this call just add the Ids in the following api call URI and download the documents:
Image RemovedImage Added
How to use variables in Postman
Let us start with the authentication but this time we will use variables, so we do not have to remember the api token for all other requests.
Manage environments
Image RemovedImage Added
Section |
---|
After selecting the configuration button following window should appear: There you must fill in a name for the environment and we have to create one variable which is necessary for the authentication. Further details in the next Figure: Image RemovedImage Added First give your variable a name (it does not matter how you name them). Then fill in “initial value” and “current value” your api token. After filling up the environments for the variable, we now can use it in the header of the next request. AuthenticationThe next figure shows you the same request we have already done in the tutorial above but this time we will use the variables we have just created. Image RemovedImage Added In the first column we have our api token. In the second column we now do not have to fill in our api token, but we must write {{##name_of_the_variable##}}. From now on you can always use the variable instead of continual writing your api token because all the dates are saved in the environments. If you run this request, you should get the status “200 OK”. Upload a fileNow we will upload a file and save the file ID which we will get from the request in another variable in the environments.
Image Removed
Image AddedJust these three lines of code are necessary to save the file ID in another variable. First we will parse the response, then we set the file ID with the command (“pm.environment.set(“name_of_the_variable”, response.” name_of_the_response”). After running this request, the new variable “FileId” should be in the environments. See next Figure: Image RemovedImage Added Send an envelopeAfter saving the file id we can now send the envelope with an integration of the variable. Therefore we just fill in {{ name_of_the_variable_for_the_fileID}} instead of copy paste the file ID. This is shown in the next Figure. In the Figure 17 there is another example of how you save a date from the response. In this case we will save the envelope ID.
Image Removed
Image AddedImage RemovedImage Added Download the fileFirst we get the File Ids and save them in our environment: Please note: The document must be finished! Otherwise it is not possible to retrieve the document Ids. Image RemovedImage Added After we have saved all document Ids we can use them for the download request. Image RemovedImage AddedOverview of all variablesImage RemovedImage Added Advantages of using variables in PostmanFirst, we do not have to remember all dates which we get through all the requests. Furthermore, we can simply change the organization key and the username and wen can play all requests without other changes because the variables auto fill in the new dates in the requests. Moreover we have a better overview of all ID`s so that we can easily match them with the requirements of the requests. |
...