Using Knock with Postman
Our Postman collection is a good way to get familiar with the Knock API. Here's how to get started.
In this guide you'll fork the Knock collection into your Postman workspace and create Postman environments that map to your environments in Knock.
For the Knock Postman collection
- Install Postman if you don't have it already.
- Fork the Knock API Postman collection. We recommend forking the collection (as opposed to creating a copy) so that you can pull changes we make to the source collection.
- We provide a separate Management API Postman collection. You can use use this to test our Management API.
Configure your Knock environments in Postman
We recommend creating a Postman environment for each of the environments you're using in Knock. This way you can store environment-level variables (such as API keys) and easily switch between environments without having to update your endpoint parameters.
- Navigate to the "Environments" section in Postman. You should see an environment named "Knock environment template".
- Duplicate the template so you have one environment in Postman for every environment you use in Knock.
Once your environments are in place in Postman, grab the secret key from their corresponding environment in Knock and add it to the environment's secret key variable in Postman.
You're all set to send requests to the Knock API from your Postman workspace.