Introduction
This article describes how to run the Docman API collection in the postman desktop client.
Postman is an API development tool that makes sending and receiving web requests to a REST API easy! Use postman to test and learn the Docman API before implementing any code.
Run in Postman tutorial
The tutorial starts on the Docman API online documentation page.
Click on “Run in Postman” button
A new page will open. “Click Postman for Windows” to run postman in the native postman desktop application. Make sure you have already installed the postman application and if not click here to download and install.
Postman as a Google Chrome app is now being phased out and not supported by Docman
In chrome an alert might show up to set a default app for opening postman links. Click on “Open Postman”.
The Docman API collection will be imported into the postman application as new collection named “Docman API”.
To make it easy Docman have set up a sandpit environment to test the Docman API against. This is also configured as a postman environment, all web requests in the Docman API collection reference variables in the postman environment named “Docman Public Sandpit”.
Note: The variable values are blank to start with and you need to modify some of them with details provided by Docman such as API username and password.
To edit the variables, continue to follow this tutorial. Alternatively, edit the variables in each call in the Docman API collection.
To edit the variables, continue to follow this tutorial. Alternatively, edit the variables in each call in the Docman API collection.
Click the cog icon in the top right of the postman application.
Click “Docman Public Sandpit”.
Modifiy the values using the table as guidance and click “update”.
| Value | Description | Required |
| ENV_HOST | URL of API, this will be provided to you by Docman | Yes |
| ENV_HOST_PORT | Either HTTP or HTTPS | Yes |
| ENV_USERNMAE | Unique username supplied to you by Docman. | Yes |
| ENV_PASSWORD | Unique password supplied to you by Docman. | Yes |
| ENV_ODSCODE | Organisation OdsCode you are trying to send and receive documents for | Yes |
| ENV_PATIENT_ID | NHS Number of patient you are trying to interact with | No |
| ENV_DOCUMENT_GUID | Document guids are used in the web request and this value can be modified at runtime. | No |
Using Docman API in Postman