---
title: "How to use Postman"
slug: "how-to-use-postman"
description: "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."
updated: 2026-07-01T04:50:49Z
published: 2026-07-01T04:50:49Z
canonical: "docs.document360.com/how-to-use-postman"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.document360.com/llms.txt
> Use this file to discover all available pages before exploring further.

# How to use Postman

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]
> NOTE
> 
> For more information regarding Postman application, read the following articles.
> 
> - [How to download Postman application?](https://www.postman.com/downloads/)
> - [How to install and update Postman application?](https://learning.postman.com/docs/getting-started/installation-and-updates/)
> - [How to use Postman?](https://learning.postman.com/docs/)
> - [FAQs in Postman](https://www.google.com/search?q=FAQs+in+Postman%3F&rlz=1C1CHBD_enIN1119IN1119&oq=FAQs+in+Postman%3F&gs_lcrp=EgZjaHJvbWUqBggAEEUYOzIGCAAQRRg7MgoIARAAGIAEGKIE0gEHNjI5ajBqN6gCALACAA&sourceid=chrome&ie=UTF-8)

---

## Linking your Document360 project in Postman

1. The below steps are based on the on-premises Postman application.
2. Open the Postman application.
3. In the **My Workspace** section, click on the **Import** button.

An **Import** popup panel appears.
4. Enter the below URL in the field. [https://apihub.document360.io/swagger/v2/swagger.json](https://apihub.document360.io/swagger/v2/swagger.json) The **Choose how to import your API** pop-up will appear with two options.
5. Select the desired option
  - Postman Collection (default)
  - OpenAPI 3.0 with a Postman Collection
6. 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.

![Steps to link your Document360 project in Postman](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/10_ScreenGif-Postman.gif)

## 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](https://apidocs.document360.com/apidocs/api-token).

> [!NOTE]
> NOTE
> 
> **Generating an API token**
> 
> 1. Navigate to **Settings** () in the left navigation bar in the Knowledge base portal.
> 2. In the left navigation pane, navigate to ****Knowledge base portal**** > **API Tokens**.
> 3. Create the desired API token and copy the token.
> 
> (or) Copy the token from an existing token.

![Steps for authorization in Postman after importing Document360 project](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/11_ScreenShot-Postman.png)

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.

![Steps to authenticate Document360 project](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/9_ScreenShot-Postman.png)

### 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?](https://apidocs.document360.com/apidocs/how-to-create-and-publish-an-article)
- [How to update a published article?](https://apidocs.document360.com/apidocs/how-to-update-a-published-article)
- [How to update SEO details?](https://apidocs.document360.com/apidocs/how-to-update-seo-details)

---

### FAQ

****What should I do if my Postman session ends after refreshing the page?****

If your Postman session ends after refreshing the page, you will need to authenticate again. Follow the steps provided in the article to re-authenticate.

Application Programming Interface - A set of defined rules and protocols that allows one software application to communicate with and request functionality from another. APIs are the backbone of modern integrations. When Document360 connects to Slack, Intercom, or Google Analytics, it does so through their APIs. Document360 also provides its own REST API, enabling teams to programmatically manage articles, categories, and reader accounts from external systems.

## Related

- [How to use Swagger](/how-to-use-swagger.md)