Introduction to Postman
Postman is a collaboration platform for API development. It helps in storing and using API requests, which is beneficial for our customers in API integrations and testing.
Why Use Postman
We recommend Postman for several reasons:
- Ease of Use: User-friendly interface.
- Community Support: Extensive learning resources available.
- Import Collections: Easily import our request collections.
- Environment Parameters: Manage multiple environments efficiently.
Discover Our Postman Collection
- API Token: Ensure you have an API token. If not, refer to our guide on creating your first API token.
- Download Postman: Download Postman
- Download Collections:
Importing Collections
- Extract Files: Unzip the downloaded files.
- Open Postman: Launch the Postman application.
- Import Process:
- Click the Import button.
- In the popup, select the File or Folder tab based on your preference.
- Drag and drop the extracted files into the import box.
- Select the collections you want to import and ensure the environment collection is selected.
- Click Import.
Your collections will now appear in the Collections tab. The environment file will be in the top-right corner of Postman.
Using Environments
Environments in Postman allow you to group variables that can be used in your requests. Our CheckHub collection uses environment variables stored in the provided file.
Manual Environment Import
- Find the environment file in the archive (e.g.,
CheckHub_%%%.postman_environment.json).
- In Postman, click the manage environment button.
- Click Import and select the environment file.
Using Environment Variables
To use CheckHub API comfortably:
- Copy your API key into the environment settings.
- Click Update.
This key will now be used in all requests requiring authorization.
Conclusion
You are now ready to work with CheckHub API using Postman. Happy coding!