←back to tutorials

How to import and use the ChatBotKit API in Postman

This tutorial provides a detailed guide on how to utilize the ChatBotKit API using Postman, covering everything from importing the API specification to configuring authentication.

Prerequisites

Before starting, ensure you have Postman installed on your machine. If not, download it from Postman's official website.

Step 1: Import the API Specification

  1. Obtain the OpenAPI Specification:
  2. Import into Postman:

    • Open Postman and log in.

    • Select your preferred workspace.

    • Click on the Import button at the top left.

    • Choose the Link tab and paste the URL https://api.chatbotkit.com/v1/spec.json.

    • Click on then Import to load the specification into Postman.

Wait a few moments for the API to be fully imported into your workspace.

Step 2: Configuring Authentication

  1. Set Up Authorization:

    • In Postman, navigate to the root folder of the imported ChatBotKit API project.

    • Go to the Authorization tab.

    • Postman should automatically configure most parameters, including adding a placeholder for the environment variable bearerToken.

  2. Create an Environment for Tokens:

    • Navigate to the Manage Environments section by clicking on the designated icon in the upper right corner.

    • Click Add to create a new environment.

    • Name it “ChatBotKit Production.”

    • Add a variable named bearerToken, set its type to Secret, and paste your ChatBotKit API Token into the value field.

    • Click Save.

  3. Select the Environment:

    • Choose the newly created environment from the environment dropdown at the top right of the Postman interface.

Handling API Changes

ChatBotKit ensures that all future versions of the API are backward compatible, but you may need to re-import the API specification to access newly added features. Repeat the steps in this tutorial whenever there is an update to the API.

Creating an API Token

If you do not have an API token, create one by visiting this link. Follow the prompts to generate a new token and use it in your environment settings as described above.

Conclusion

You are now ready to explore and utilize the extensive features offered by the ChatBotKit API through Postman. Start making API calls to test and integrate ChatBotKit functionalities into your applications.

This revision aims to clarify the steps, add structure, and improve the overall flow and presentation of the tutorial.

APIPostmanAIChatBotKit