Key Features

Making API Requests with Postman

Making API Requests with Postman

Making API Requests with Postman

After deploying an API, you can verify that it is working properly using a client tool.

This guide uses Postman.


Step1: Install and Launch Postman


Download the tool from the Postman website and launch it.

At the top of the Postman interface, click the + button to create a new HTTP request.


Step2: Configure the POST Method


Set the method to POST and enter the endpoint URL.

The endpoint can be found in the API Usage page by clicking each tab.



Step3: POST - Configure Headers


In the menu, click the Headers tab and enter the Key and Value.

  • Key: x-api-key

  • Value: Your issued API Key

When the API Key is generated, be sure to store it securely and copy it when needed.



Step 4: POST – Configure Body


Go to the Body tab and enter the Key and Value.

  • Key: params_json (set as Text)

  • Value: Input data for the node in JSON format

Example:


{

"Name": "Joy",

"BirthDay": "20010101"

}



Click Send, and a Request ID will be returned.


Step 5: Configure the GET Method


Set the method to GET and enter the same endpoint URL as in the POST request.

This time, append the Request ID obtained from the POST request to the URL in the format:

/{Request ID}/status



Step 6: GET – Configure Headers


In the menu, click the Headers tab and enter the Key and Value.

The values are the same as in Step 3.



Step 7: Verify Results


The GET method does not require a Body.

Click Send to call the API and check the returned result.



Step 8: Using cURL


On the right-hand side, click the button to view the cURL code sample.