Using the APIs with our Postman collection
Try all of the example requests in our API documentation through the popular PostmanOpens in a new window REST client. Install our Postman collection, optionally configure your environment, and execute the requests.
Table of contents
1. Installing the Postman collection
If you don't have Postman installed, you can get it from the Postman appsOpens in a new window page.
Then, use the following button to quickly install a Kentico Kontent collection of requests:
Postman will ask in which its variant the collection will open. After confirming all dialogs, the collection will appear in the left pane:
2. (Optional) Configuring your environment
Postman environmentsOpens in a new window are 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.
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.
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.
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 accountOpens in a new window on Postman servers.
We advise against storing your API keys in your collection permanently as the collection might be mistakenly shared or exported together with these keys. To prevent this, you can store your API keys in Postman environment variables and use those instead.
Enjoy playing with our APIs!