Trados Cloud Platform APIs for Postman

We provide a Postman collection for quick and easy usage of our RESTful APIs.

Installation

You can download the Postman collection from here.

If you make use of multi-region, we also provide the EU and CA Postman Environments.

There are 3 setup options:

  • Copy the collection URL from above and import it into Postman using Import > Link.
  • Copy the entire file content and import it into Postman using Import > Raw Text.
  • Save it as a JSON file on your computer and import it into Postman using Import > File.

image


Configuration

The imported collection is already set up for you to get started as fast as possible.

We make use of collection level variables and an inherited authentication mechanism.

For example, authentication is already set up to use the Bearer Token scheme and will use the token value provided by {{lc-access-token}} variable. This token is populated with the correct value, each time you Obtain a client credentials access token, via the Tests tab.

One thing you need to do before proceeding is to fill in the {{lc_tenant}} variable with your own tenant ID. Prepend the ID with LC- so the final value looks like this LC-00000000000000000.

Don't forget to save the collection!

image


Multi-region environments

If you have imported the regional Postman Environments, please note that any environment-level variables (e.g., baseUrl) will overwrite collection variables. This means that when you have an environment selected in Postman, the value of baseUrl will be the one defined in the environment, not the value defined at the collection level.

Authentication

To start working with the Trados Cloud Platform API, you first need to authenticate.

You can find the authentication call under the Authentication (Start Here) folder. Fill in your client_id and client_secret and perform the request.

If the authentication is successful, the token will be extracted automatically from the response and saved to the {{lc-access-token}} variable.

image


Usage

After you have authenticated successfully, you can start interacting with the Trados Cloud Platform API.

For example, we can get information about a project by using the GetProject request from the Project folder.

Simply fill in your projectId and click SEND. Optionally, you can supply values to the fields parameter to receive only data that is of interest.

image

Warning

Make sure you are not sending any query parameters with default Postman values. If you are sending any parameters, make sure you are sending valid data or else you will get an API Error.

image