isabella232 / languagecloudpostman

Postman files for Language Cloud Public API

Language Cloud APIs for Postman

A Postman collection for quick and easy usage of our RESTful APIs.

Installation

You can download the Postman collection from here.

Either copy the collection url from above, save it as a json file on your computer or copy the entirety of the file content and import it into Postman.

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 exaple, the 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 being 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 LC-00000000000000000

Don't forget to save the collection!

Authentication

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

You can find the authentication call under the Authorization (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.

Usage

After you have authenticated successfully, you can start interacting with the Language Cloud 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 paramater to recieve only data that is of interrest.