Using the APIs with our Postman collection

Try all of the example requests in our API documentation through the popular Postman REST client. Install our Postman collection, optionally configure your environment, and execute the requests.

You can also view our Postman documentation as a part of the Postman API Network.

Table of contents

    1. Installing the Postman collection

    If you don't have Postman installed, you can get it from the Postman apps page.

    Then, use the following button to quickly install a Kentico Kontent collection of requests:

    Run in Postman

    Postman will ask in which its variant the collection will open. After confirming all dialogs, the collection will appear in the left pane:

    The Kentico Kontent collection for Postman

    2. (Optional) Configuring your environment

    In Postman, environments are just sets of variables and their values. These variables can then be used everywhere in Postman (in your requests).

    In our collection, there are already all the appropriate variables defined in the collection's property dialog (accessible by right-clicking and hitting Edit). They have also been given sample values.

    The variables defined in the Postman collection

    But, you may want to clone these variables into your own environment for two reasons:

    • You can have several environments that hold several sets of values of the variables.
    • When a variable is defined in an environment (instead of the Edit dialog of the collection), Postman will offer these variables via its auto-complete functionality every time you edit the example requests.

    Using a variable that has been defined via an Environment

    3. Executing the API requests

    In the left pane, the collection can be expanded. The collection's structure mimics what you see in the navigation on this site. In each folder, you'll find requests.

    You can execute the request by clicking Send. If you have an Environment configured and selected in the top right corner of the window, the variable values of the Environment will be used. Otherwise, the values configured in the collection's Edit dialog will be taken into account.

    Upon clicking Send, you'll be presented with a response.

    A JSON response to a sample API request

    Storing your API keys

    You can supply your API keys to the sample requests by right-clicking the folders in the collection and clicking Edit. Then, in the Authorization tab you'll be able to insert your API key.

    Keys are synced into your Postman account in the cloud

    The API keys, once configured, will be synced to your Postman account on Postman servers.

    We advise against storing of the API key in your collection permanently.

    Warning: Do not share the collection further with your API keys in it

    We advise against storing your API keys in your collection permanently as the collection might be mistakenly shared or exported together with these keys.

    Enjoy playing with our APIs!