In software or web development, APIs (Application Programming Interfaces) are the building blocks that allow different systems to communicate and share data. As most of you are probably already aware, HubSpot’s platform offers a suite of powerful APIs that developers can use to create custom integrations and extend the functionality of the HubSpot platform.
One of the most popular tools for working with APIs is Postman, a platform that simplifies the process of building, testing, and sharing APIs.
In this blog post, we will introduce you to HubSpot's newest Postman workspace and how we hope these newly generated API collections based on HubSpot’s public API schemas will allow you to easily access, utilize, and test HubSpot’s public APIs.
What is Postman?
If you aren’t familiar with Postman, let us introduce you to this tool. Postman is an API development and testing platform. It's a tool that allows developers to create, test, document, and share APIs in a user-friendly environment. It's widely used to simplify the process of testing APIs, providing a graphical interface for making requests, viewing responses, and debugging issues.
HubSpot uses Postman because it provides features that help users understand our APIs better and allow us to share them easily.
Introducing HubSpot’s New Postman Integration and Workspace
Postman and GitHub Integration
Recently, HubSpot’s Developer Advocates and API Tooling team were brought together to provide HubSpot developers with the most up-to-date API definitions by establishing a unique integration. This integration is between our GitHub repository, containing OpenAPI 3.0 schemas, for our public APIs and Postman.
With Postman, we can pull the latest schema changes from this repository. For instance, the integration built by API Tooling is designed to automatically track and reflect any modifications made to the API schema. So when an API schema is changed, that change is immediately captured, and the API specification in the repository is updated and reflects this change within Postman with a simple pull request.
This ensures that any modifications, additions, or updates to HubSpot API schemas can be easily pulled into Postman. As soon as the changes are pulled into Postman, HubSpot's staff updates the collections based on the updated schemas, followed by publishing a new API version.
