Postman for DOC²#
This guide will show you how to make HTTP requests to your DOC² organization via Postman. It is easy to use and very useful for organization administrators.
Setup#
First, download Postman to your system and sign in/register.
Now follow this step-by-step guide to learn how HTTP requests work in Postman.
Authorization#
In Postman#
Before you can create your HTTP requests, you need to enter your API key from DOC² to authorize them.
1. Click on the Authorization tab und choose API Key as authorization type.
2. Fill in the values. Enter "x-api-key" in the Key field and your API Key as value (found in DOC² Settings menu Integration) Select the Add to Header.
It should look like this:
On api.polydocs.io#
1. Click on Authorize in the upper right corner
2. Enter your API Key and confirm by clicking Authorize
Create a new Workspace in Postman#
1. Click on Workspaces and create a new workspace (you can name it whatever you want).
2. You have to select the visibility which determines who can access this workspace.
3. After making your selection and clicking Create Workspace select Collections on the left side of the application and create a new collection for your HTTP requests by clicking +.
In this collection, you can add multiple HTTP requests. To do this, click on the 3 points of the collection and select Add request.
"GET" Method example#
The GET method is very useful to get information about users, sub-organizations, processed documents and much more.
1. Choose the GET method in your HTTP request.
2. Authorize yourself as described above.
3. Open api.polydocs.io and add the path of the function behind the polydocs URL. For example:
1 | |
4. Now paste this link in the text box next to the GET method in Postman.
Click Send and you should receive all the information about every user in your organization.
"POST" Method examples#
The POST method is usually used to create users or organizations, for example. This method inserts information into the database.
Create User#
1. Select the POST Method.
2. Authorize yourself as described above.
3. Open api.polydocs.io and add the path of the function behind the polydocs URL. In this case:
1 | |
4. Now paste this link into the text box next to the POST method in Postman.
5. Select the Body tab in your HTTP request and enter the keys and the values for each credential that has a red asterisk next to its name.
When you're done, it should look like this:
If you want to create an admin account, set the is_admin value to true.
Finally, click Send and you can see all the credentials you set in the response below. This means the user has been created.
Upload document#
You can also use the POST method to upload a document to DOC².
1. Select the POST Method.
2. Authorize yourself as described above.
3. Open api.polydocs.io and add the path of the function behind the polydocs URL. In this case:
1 | |
4. Now paste this link into the text box next to the POST method in Postman.
5. Select the Body tab in your HTTP request and choose form-data
6. Enter file into the KEY field where you will find the hidden File dropdown. Select File and move to the VALUE field where you are able to select your file by clicking Select Files.
7. When you click Send, you should see "success": true in the response.
It should look like this:
"DELETE" Method example#
The DELETE method is used to delete, for example, users, organizations and so on.
1. Select the DELETE Method.
2. Authorize yourself as described above.
3. Open api.polydocs.io and add the path of the function behind the polydocs URL. For example:
1 | |
4. Now paste this link in the text box next to the DELETE method in Postman.
5. Replace the {user_id} at the end of the URL with the actual user ID you want to delete. (You can get the user_id using the GET method).
6. If you included the user_id in the URL, you don't need to add a body key and value for it.
7. When you click Send, you should see "success": true in the response.
It should look like this:
"PUT" Method example#
The PUT method is mainly used to update user or organization data. It is very easy to understand and use.
1. Select the PUT Method.
2. Authorize yourself as described above.
3. Open api.polydocs.io and add the path of the function behind the polydocs URL. For example:
1 | |
4. Now paste this link in the text box next to the PUT method in Postman.
5. Replace the {user_id} at the end of the URL with the actual user ID you want to delete. (You can get the user_id using the GET method).
Suppose you want to change the email address of a user in your organization.
1. In the body, enter "email" as the key and the new email address as the value.
2. Then just press Send and you should see "success" in the response.
If you'd like to have this all more visualized and interactive, you can download the Postman project here to try it all out. Just click the Import button and select this file to get started right away.
