Question:
How can I get started with using the REST API in Postman?
Answer:
DocuWare’s REST API is more approachable than ever. Please refer to the following guide to set up Postman for REST API.
How can I get started with using the REST API in Postman?
Answer:
DocuWare’s REST API is more approachable than ever. Please refer to the following guide to set up Postman for REST API.
Getting Started
Postman Download
Recommended platform for testing and building applications using REST API.
DocuWare’s REST API Postman Collection
Preconfigured collection of DocuWare-relevant API calls that can be imported into Postman constantly being updated.
Importing the Postman Collection
- Unzip the downloaded Postman Collection folder. There should be two .json files inside.
- One file is for the actual collection of API calls, and the other is the environment that holds some required variables, such as your DocuWare Cloud URL, Username, and password.
- One file is for the actual collection of API calls, and the other is the environment that holds some required variables, such as your DocuWare Cloud URL, Username, and password.
- Open Postman and use the Import option near the top of the Workspace editor.
- Drag & drop the two files, or browse to the download location manually to import them both.
- Accept the prompt to import both files.
Defining Environment Variables
- Open the Environments tab on the left-hand side and select our newly imported DocuWare environment
- Here you will notice a ton of different variables, but most are use-case specific and can be left alone for now. Some important ones to get started are:
- ServerUrl (ending in .cloud / .com etc. - we are filling the DocuWare/Platform in another variable)
- Username
- Password
- Save your changes.
Getting Authenticated
There are a handful of ways to authenticate using the REST API, but the simplest is using our Username & Password. The Postman Collection has these all numbered accordingly to help make this a simple process:- Open the Authentication/OAuth folder in the Postman Collection
- Start with the 1. Get Responsible Identity Service call and press Send. Assuming your ServerUrl variable is set correctly, you should receive a 200 response:
- Next, do the same for 2. Get Identity Service Configuration
- Finally, choose the authentication method you’d like to use. In this example, we’ll use 3.a Request Token w/ Username & Password, and we should receive our Access Token in the response.
- Now you’re properly authenticated and can start testing the various other calls within the Postman Collection!
Most of our REST API documentation can be found directly in Postman itself via the Documentation tab on the right-hand side:
KBA is applicable for both Cloud and On-premise Organizations
