Docusign Insight - Using Postman to test Insight APIs

If you need to test the Seal APIs and do not wish to useĀ curl, then you might want to look to Postman. It iss available as an app to download or as a plug-in in Chrome. You can get these from https://www.getpostman.com/ or from the Chrome store respectively. To be able to use it to test Seal APIs then you need do go through three steps.

1. Get Nonce

All the APIs work off the nonce so you need to get a nonce first. This is pretty straight-forward in using Postman. All you need to put into this request is the request URL. That request URL is the API end point + /security/nonce. It is a simple GET request that doesn't require any other fields to be set. The resulting value you will use in the next call.

2. Login

Once you have the Nonce, then you will be able to login and get a X-Session-Token that you will use for all future calls. This call is when it starts to get a little complex in how you use the Postman tool.

First you want to construct your request URL. This should be your API end point + /auths. Then change the method from GET to POST. Then you need to select the Headers tab and add a key/value pair of Content-Type: application/json as in the example below.

Then change to the Body tab and select and select the option raw. Then create the json parameters that are part of the auths request. According to the API specification the format is as follows.

{
  "principal": "user1",
  "password": "my_secret_password",
  "nonce": "aosd7r937r0f0baba..."
}

The screenshot below shows an example of how this would be setup.

You can now send this through to get the X-Session-Token. It will be returned in the Headers like the following.

You will need to copy the value of the X-Session-Token to use in the your next call, which can be almost any API in the system.

3. Example API

For the purposes of the next API you will call the Settings API end point. This returns some basic system information.

This shows the basics of what you need to do. You will need to add the X-Session-Token into the header request in addition to any other item listed in the API specification. For Settings, the API specification notes that we need to set the Content-Type. So an example setup of this API is shown in the screen shot below.

This will outputĀ JSON object with the Settings information.

{
"shouldShrugPdf": false,
"useAnalytics": false,
"useAlertEmail": false,
"shouldExportPdf": true,
"locations": [
{
"languages": [],
"path": "\\\\10.27.0.5\\Users\\sara.hosny\\Desktop\\fml",
"isEnabled": false,
"type": "FileSystem",
"referenceName": "new"
},
{
"languages": [],
"path": "\\\\10.27.0.4\\Import",
"isEnabled": true,
"type": "FileSystem",
"referenceName": "test2"
}
],
"scheduledRuns": {
"minutes": 0,
"days": [
""
],
"hour": 0
},
"shouldRescan": false,
"useAutoAssignment": false,
"shouldOverrideMetadata": false,
"autoCreateCustomMetadataFields": false
}