Authentication Using Postman

This tutorial assumes that you already have Postman installed, and are also already logged in to your account. If you need to get up and running with Postman, please visit the Postman tutorial center for useful links and tutorials.

 

Authentication and Using Your Application

In order to use any of the iCheckGateway APIs, the application or client should first be authenticated using our Auth API with valid credentials (username & password).

There are two ways to get a copy of our public API endpoints for testing using Postman.

 
Method 1: Forking the existing iCG Public Collection

This method is the easiest and most direct. Please proceed as follows:

  1. Click on the Run in Postman button displayed below
  2. A pop up dialog box will appear. Click on the orange Fork Collection button (it's found on the bottom right of the pop up screen).
  3. A page will load in the a new window. In the resultant screen, under the Fork Label textbox provide a name that is easy to remember. For example, you can call it John Doe's Fork of iCG endpoints. Also, select an appropriate Workspace under the Workspace field.
  4. Click on the Fork Collection button to complete the process. A new collection will now be added to your existing ones.

 

Method 2: Importing the Collection Manually

Open Postman, then select your preferred workspace. Click the Import tab, as shown in figure 1 below:

Figure 1: Accessing the import option in Postman

 

Upon clicking Import, a dialog box pops up. In the box written “Paste cURL, Raw text or URL”, paste the following link: https://icgdocs.live/wiki/wp-content/uploads/2023/09/iCheckGateway-Public-Endpoints.postman_collection.json

Once you’ve successfully imported the file, a collection with the name iCheckGateway Public Endpoints will appear.

You will need to customize this request with your own credentials. To do so, click on the Body tab, and then edit the username and password with your own details. Leave the rest unchanged. See figure 2.

 
The Authentication Process

Once you've successfully imported/forked the API collection as directed above, navigate through the following folders: Auth > Account. Trace the endpoint with the name Allow a user to login to the system.

You will need to customize this request with your own credentials. To do so, click on the Body tab, and then edit the username and password with your own details. Leave the rest unchanged. See figure 2.

Figure 2: What to change in the Postman body

Upon successful entry of credentials, press on the blue SEND button at the top right corner of the Body tab. A token will be generated, similar to the one in figure 3 below:


Figure 3: A sample token generated upon successful credential entry

Copy the values between the quotations next to the “access_token” parameter. Copy this token for use in your API calls.

Please note that this token expires every 24 hours, so you’ll need to refresh this token often.

When making an API call to any of our endpoints, always have your username, password and access token handy.