Choose the GET method in your HTTP request.Ģ.
The GET method is very useful to get information about users, sub-organizations, processed documents and much more.ġ. To do this, click on the 3 points of the collection and select Add request. In this collection, you can add multiple HTTP requests. 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 +. You have to select the visibility which determines who can access this workspace.ģ. Click on Workspaces and create a new workspace (you can name it whatever you want).Ģ. Enter your API Key and confirm by clicking Authorizeġ. Click on Authorize in the upper right cornerĢ. 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.ġ. Click on the Authorization tab und choose API Key as authorization type.Ģ. Authorization # In Postman #īefore you can create your HTTP requests, you need to enter your API key from DOC² to authorize them.ġ. Now follow this step-by-step guide to learn how HTTP requests work in Postman. Setup #įirst, download Postman to your system and sign in/register. It is easy to use and very useful for organization administrators. Postman provides an editing tool to document your API.
#Postman document how to
This guide will show you how to make HTTP requests to your DOC² organization via Postman.
#Postman document pro
You can check your usage limits through the Postman Pro API or the account usage page.DOC² Postman Guide Setup HTTP request Admin Postman for DOC² # Your Postman account gives you a limited number of free documentation views per month. When including block elements, ensure that you leave an empty line before and after to avoid any rendering issues.įree documentation views with your Postman account GitHub flavored markdown is also supported, so you can even include tables. Descriptions can be customized using Markdown styling with embedded graphics to complement your documentation.
#Postman document code
The public view is accessible via the public link, generated when you publish your documentation. To obtain a copy, please file a request through our FOIA Branch. In order to access the private view, click “View in web” in the Postman app or in the “Team Library”. This document may require redactions before it can be viewed. Each collection has a private and public documentation view, generated in real-time using the data synced to our servers. Postman generates and hosts browser-based API documentation for your collections automatically in real-time. The law requires the sex designation on Kansas driver’s licenses and birth certificates to reflect a person’s sex at birth, the state’s Republican attorney general said in a legal opinion Monday. Postman’s API documentation feature allows you to share public or private API documentation, beautifully viewable via a web page.
0 kommentar(er)
