/ library

Releasing Postman collection of v2 API

We recently announced the new version of the HyperTrack API. We want to make it extremely easy for you to get started with the API.

The ability to invoke the API, modify the requests and view the responses in an easy to use interface can be a valuable tool when beginning the initial design work of your application as well as debugging issues you might be encountering. Which is why we have added a Postman collection for our API.

What is Postman?

Postman is a free client application that allows making calls to any API very easily. We use it internally at HyperTrack. It helps us develop and test our APIs.

With Postman, you can share your endpoints in collections with whomever you want. And that is what we are sharing with you today: our whole collection of endpoints for you to play with!

Why is the collection useful?

  1. It is comprehensive covering all the endpoints of hypertrack.
  2. It has multiple requests for the same endpoint, each with different set of parameters. For example, a POST request on actions/ can be made with several optional paramters based on your use case. Similarly a GET request can be made with one of several filtering or ordering paramters. You can edit these sample requests as a starting point for programming your own use case.
  3. It has sample responses for all endpoints. For a given request, you can see this by clicking on Examples in the Postman app. You can see the response object without even making a request.
  4. It is easy to use for developers using hypertrack for the first time. Several API requests like retrieve an action require an id in the url before being tested. This collection initializes environment variables automatically, so that you don't have to create an action before testing the retrieve API. We have used variables, pre-request scripts and tests of Postman sandbox environment to setup the collection. Follow step 3 of next section to make use of this.

How to use it?

  1. Get the HyperTrack API v2 collection
  2. Sign up and get your SECRET_KEY. Set it as the value of the hypertrack_sk collection variable.
  3. Optional: Run the 1st folder of the collection. Select Persist variables option before running. This will run the requests in that folder and automatically set global variables like user_id, action_id and so on, that are used by other requests in this collection. If you don't follow this step, you will have to manually add variables that are used by the API request you are testing.

Feedback welcome

If you find any issues in the collection or want a specific example added to it, please ping us on our slack community channel.