Get Started
  • 1 Minute to read
  • Dark
    Light

Get Started

  • Dark
    Light

Article summary

This topic describes how to access Syndigo Restful APIs using Postman.

Note:

You can use various tools other than Postman to access Syndigo Restful APIs. Since Postman is the most widely used tool to access Syndigo Restful APIs, this topic describes how to access Syndigo Restful APIs using postman.

Prerequisites

The following are the prerequisites:

  • Download Postman - The following URL can be used to download Postman: https://www.getpostman.com/downloads/
  • Ensure you are aware of the Client userName and Client Secret Keys. If you are not aware of the Client userName and Client Secret Keys, contact the Syndigo Operations team.

Important Aspects in Postman

The following are few of the important aspects that must be known to you while using Postman:

  • Collection: A collection is a group of API requests.

  • Variables: Variables in Postman are key-value pairs. Each variable name represents its key, so referencing the variable name allows you to access its value. For example, if you have a base URL for requests stored in a variable named base_url, you can reference it in your requests using {{base_url}}.

  • Environment: An Environment is a group of variables that we can use in a Postman request. By creating Environments for production, testing, staging, and so on.

  • Params: Request params are used to send additional information to the server.

  • Headers: Headers in an HTTP request or response are the additional information transferred to the user or the server. In postman, the headers can be seen in the Headers tab.

Postman

Postman Call Collection

Import the collection of common examples below.

CXH API Postman Examples.json


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Eddy, a generative AI, facilitating knowledge discovery through conversational intelligence