Using Postman as developer tool

What is Postman

Postman is a collaboration platform for API development. In CheckHub's case it is a tool for storing and using API requests which helps our customers in API integrations and testing API requests.

Why using Postman

We advise it in the collaboration with our requests collection. Also, it is:

• easy to use;
• with big community and learning center witch contains a lot of useful and understandable information;
• you can import our requests collection; 
• using environment params;
• etc.
  
  

Discover our Postman Collection

Since you have access to the CheckHub API via the access token, you can test your requests in the Postman application. 

This link could help you in How to manage your API keys.

Here you can download the Postman application.

Here you can find archives to work with our API:

• Staging Postman collection (if you have a test environment).
• Production Postman collection.

Please contact us, if you have questions or something went wrong.

The archive with collections must contain all existing modules files + environment file in JSON format.

Example files.

How to import collection:

• Firstly you should extract files from the archive and run the Postman app.
• Click the Import button.

• Then you can see the opened Import popup with tabs. We are interested in one of 2 tabs: FIle or Folder.
  Choose the File tab if you want to copy only selected files.
  Choose the Folder tab if you want to copy the extracted folder.

• Drag and drop extracted collection files into the D&D box.

• Then a table with marked collection items appears in the popup. Here you can choose which collection you want to import and which you don't want. Just unmark the checkbox near the needed row. 

Make sure that you didn’t unmark the environment collection. It is necessary in requests.

• When you are ready - click the Import button.
• Hurray! All needed collections are imported. You can find them in the Collections tab.

If the Environment file was imported successfully you can find it in the right corner of the Postman application.

An environment is a set of variables you can use in your Postman requests. Also, you can use environments to group related sets of values together.

Whole CheckHub collection requests contains environment variables, which stored in this file. 

Usage example:

How to import the environment manually.

Firstly find file in the collection archive named like: CheckHub_%%%.postman_environment.json

INFO: If the collection doesn’t contain such a file - please contact us, we'll help you.

Then in the Postman app click on the manage environment button.

In the opened popup click on the Import button.
Then, choose the CheckHub_%%%.postman_environment.json” file. Voilà! Environment successfully imported.

How to use environment variables.

For CheckHub collection comfortable usage it is necessary to use API keys in the environment variables.

Copy your API key into the environment settings and click “Update” button:

Now it will be used in all requests which need Authorization.
Example:
 Here we go! You are ready to work with CheckHub API.

How to use - some examples

So, you have access to the CheckHub API, try something to do with that!

Let's GET data:

• Start from opening a collection folder, for example - Accounts, and click on 

  GET /accounts request.

• Then, click on SEND button;

• And check results in the response body section.
  
  

How to POST (create) data:

We have already opened the Account collection, so we could go on with it.

• Open POST /accounts request;
• Open a Body tab;
• Enter needed information about your new account in JSON format or use the provided data example.;
• Click on the SEND button;
• Check results in the response body section.

Additional Infos

Postman learning center - here you can find more useful information about Postman application.

API documentation - Please read it to be familiar with our API

Troubleshooting & Error handling -  a useful article if "something went wrong" and you didn't expect such request response.

In any case if you have questions or troubles - please contact us, we would be glad to help you.