...
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 |
|---|---|
Steps:
|
Create a request
After creating a new Collection, we will save our first request into it.
| Figure | Description |
|---|---|
Steps:
|
Authentication
The next request will show you an authorization. This is an important part of the requests for sure but not only because of security but also because we will need the authorization for all following requests.
...
Please see the next sample authorization (Bearer token):
| Key | Value |
|---|---|
| "Authorization" | "Bearer asdfngtmvv8pfmsuaxpzz85zux3e63dd9zttrwitx9mln6qka6tds83du3p3lroe" |
Please see the next sample authorization (api token):
| Key | Value |
|---|---|
| "ApiToken" | "asdfngtmvv8pfmsuaxpzz85zux3e63dd9zttrwitx9mln6qka6tds83du3p3lroe" |
You can find this information in Settings / Api Tokens and Apps. Note that all API methods require an authentication. The API token is a user specific secret which should not be shared with other users. We recommend to create different API keys for different application integrations, to avoid configuring the same key in various integration systems. This allows, e.g. in case of sharing a key by mistake, to disable one key while keeping other integrations working with their existing configuration.
...
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.
| Figure | Description | |||||||
|---|---|---|---|---|---|---|---|---|
Steps:
Response
|
Upload a file
| Note |
|---|
| It is not allowed to upload multiple files at once (when more files are selected). |
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.
| Figure | Description | |||||||
|---|---|---|---|---|---|---|---|---|
Steps:
Response
Please note: The FileId is needed for the next api call. |
Sending an envelope
Send the first envelope with the document you have chosen from the upload 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.
| Figure | Description | |||||||
|---|---|---|---|---|---|---|---|---|
Steps:
Response
Please note: The EnvelopeId is needed for the next api call. |
The following sample configuration contains two recipients with the following workflow:
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"Documents": [
{
"FileId": "8a4fd938-1234-1234-842a-be1e1d472b1c",
"DocumentNumber": 1
}
],
"Name": "Test",
"Activities": [
{
"Action": {
"Sign": {
"RecipientConfiguration": {
"ContactInformation": {
"Email": "janedoe@sample.com",
"GivenName": "Jane",
"Surname": "Doe"
}
},
"Elements": {
"Signatures": [
{
"TaskConfiguration": {
"OrderDefinition": {
"OrderIndex": 1
}
},
"IdElementId": "sample sig click2sign",
"Required": true,
"DocumentNumber": 1,
"DisplayName": "Sign here",
"AllowedSignatureTypes": {
"ClickToSign": {}
},
"FieldDefinition": {
"Position": {
"PageNumber": 1,
"X": 100,
"Y": 200
},
"Size": {
"Width": 100,
"Height": 70
}
}
}
]
},
"SigningGroup": "firstSigner"
}
}
},
{
"Action": {
"SendCopy": {
"RecipientConfiguration": {
"ContactInformation": {
"Email": "johndoe@sample.com",
"GivenName": "John",
"Surname": "Doe"
}
}
}
}
}
]
} |
...
Before downloading the documents we need the file Ids. Therefore the following api call is necessary:
| Figure | Description | |||||||
|---|---|---|---|---|---|---|---|---|
Steps:
Response
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:
| Figure | Description |
|---|---|
Steps:
Response |
How to use variables in Postman
...