Postman

Using Swagger UI for API client development
This page shows how to use the Postman API Client to explore and test the Tradecloud API. For more information about how to use Postman in general, see the Postman documentation.

Importing the Tradecloud Postman Collection

To make things easier, Tradecloud provides a Postman collection with some example requests. You can use this as follows:
  1. 1.
    Save the Tradecloud Postman Collection on your computer. (Use right-click, save link as)
  2. 2.
    In Postman, click "Import" and select the file collection you just downloaded.
You now have a "Tradecloud Demo" collection in your Postman application. Follow the instructions below to start sending your first request to the Tradecloud API.

Getting a token using Postman

At the start of each session, you first need to login to obtain an authorization token. You'll need this token to authorize yourself for all subsequent requests. The token will expire automatically after 10 minutes.
To login and obtain a token:
  1. 1.
    Open the "Login" request in the "Tradecloud Demo" collection.
  2. 2.
    Go to the Authorization tab.
  3. 3.
    Fill out the Username and Password fields with your Tradecloud Integration credentials. If you don't have any credentials yet, please ask us to set up an account for you.
  4. 4.
    Click Send. The API should return a 200 - OK response.
  5. 5.
    Switch to the Headers tab of the response and copy the value of the Set-Authorization header.
    This is the token you need to use as authorization for all following requests.
Sending a Login request
Obtaining the authorization token

Sending API requests using Postman

With Postman you can easily send a request to the API once you've obtained your Authorization Token:
  1. 1.
    Open one of the requests in the "Tradecloud Demo" collection.
  2. 2.
    In the Authorization tab:
    1. 1.
      Set the Type to Bearer Token.
    2. 2.
      Paste your Authorization Token in the Token field.
  3. 3.
    Check the body of your request and change the request data where needed.
    Make sure that you follow the OpenAPI specs linked in the Postman request description (see screenshot).
  4. 4.
    Send!
Set the Authorization Token
Send the Request
Last modified 2yr ago