How to use Postman?

Plans supporting access to API token settings in knowledge base portal

Postman is an API platform for building and using APIs. Linking your Document360 project with Postman is easy and can be completed in a few minutes. You can use the on-premises or web-based Postman.

NOTE

For more information regarding Postman application, read the following articles.

• How to download Postman application?

• How to install and update Postman application?

• How to use Postman?

• FAQs in Postman

Linking your Document360 project in Postman

The below steps are based on the on-premises Postman application.

1. Open the Postman application.

2. In the My Workspace section, click on the Import button.

   An Import popup panel appears.

3. Enter the below URL in the field.
   https://apihub.document360.io/swagger/v2/swagger.json
   

   The Choose how to import your API pop-up will appear with two options.

4. Select the desired option

   • Postman Collection (default)

   • OpenAPI 3.0 with a Postman Collection

5. Click the Import button.

   Once the import is done, the action will create a sample request for each endpoint, allowing you to make the request quickly.
   

   

Authentication in Postman - Generating an API token

1. In the tree view, expand Document360 Customer API.

2. Under the Authorization tab, set the Auth Type to API Key from the dropdown.

3. Enter the desired variable in the Key field.

4. Enter the API token in the Value field. For generating an API token, read the article on Generating token.

   NOTE

   Generating an API token

   a. Navigate to Settings > Knowledge Base portal > API tokens.

   b. Create the desired API token and copy the token.

   (or) Copy the token from an existing token.

1. In the left navigation bar, go to Environments.

2. From the left navigation pane, click on Create Environments.

3. Under the Variables column, type a variable name, for instance, ‘base_URL,’ and set the Type to default.

4. Enter https://apihub.document360.io in the INITIAL VALUE and CURRENT VALUE fields for the base URL.

5. Click on the Save button.

   The project authentication is completed. Now you can easily access all the available endpoints and perform various actions.

   

Use cases

With the help of Postman, you can perform various actions in Document360.

Here are a few basic use cases for your reference

• How to create and publish an article?

• How to update a published article?

• How to update SEO details?

FAQ(s)