Test the REST API With Postman
  • 01 Dec 2021
  • 1 Minute To Read
  • PDF

Test the REST API With Postman

  • PDF

A quick way to test and get familiar with the Gladly REST API is to utilize Postman, an API debugging tool.

You can always use other methods, like curl or building your own script, but we've found that Postman provides an easily consumable UI to make API calls.

Download Postman

First, go to https://www.postman.com/ and then download the Desktop app.

postman-download.png

Generate Gladly API Token

Next, login to Gladly as a user with API User permission and generate an API token for your user.

Make an API Request

  1. Open your Postman Desktop application.
  2. Click on the + icon to create a new tab.
    postman-plus.png
  3. Click on the Authorization tab.
  4. Select Basic as the Authorization Type.
    postman-auth-type.png
  5. Enter your username (your Gladly login email) and Password (the Gladly API token you just generated).
    postman-basic-auth.png
  6. Select your HTTP request method (e.g., for GET Organziations this is GET).
    postman-method.png
  7. Enter your HTTP request URL (e.g., https://organization.gladly.com/api/v1/organization).
    postman-url.png
  8. If you are making a PATCH or POST request, remember to set the payload body by clicking on the Body tab and then selecting raw and JSON.
    postman-body.png
  9. Click Send. You'll then see an API response body and status below your request.
    postman-send.png

postman-response.png


Was this article helpful?