Using APIs (TMS)

This is a simple API scenario with sample API calls and instructions on how to chain them together to complete a simple action using only APIs. Options that can be set via the APIs are extensive. Consult the respective sections of REST API documentation to find out more about all available options.

In these examples, the standard request URL starts with https://cloud.memsource.com. In case APIs are used by an organization in the US data center, the request URL should start with https://us.cloud.memsource.com.

Scenario

Methodology

Each individual REST API call has an appropriate method listed. Using an incorrect method (e.g. GET instead of POST in the project creation call) results in an unsuccessful API call.

Step 1: Authentication

There are two authentication methods:

For the scenario, the Authentication API call is used. The generated token is required for all following API calls and is not listed in example parameters.

Use the Login API for authentication with required parameters. In this case, username and password are required.

Members of multiple TMS organizations have the same username and password for multiple accounts. In this case, the userUid must be added to the request body to specify which organization the user wants to log in to. If not specified, the user is logged in to the default account associated with the given username and password.

Step 2: Project Creation, Import, and Assignment

Project Creation

Use the Projects API call to create a project with the mandatory parameters name, sourceLang, and targetLangs.

Job Creation

With the UID from the last call, new jobs can be added directly into the newly created project using Create Job.

The expression {projectUid} serves as a placeholder in the request URL where the obtained Project UID is inserted. With the Create Job API call, the Headers of the request must be changed to match the ones required by Phrase (in other calls, Postman automatically adds appropriate headers to the request).

All the import parameters need to be inserted into a custom Phrase header.

The Content-Disposition header must include the filename in a pre-defined format in order to correctly process the import request.

To import a source file, go to the body, select binary and the Select File option appears.

Use /api2/v1/async/{asyncRequestId} to check that the job was successfully created and that it is functional.

Re-usable import settings can be configured with the Create import settings call. An import setting uid that can be used in the create job call is received in the response.

To assign providers to the job (unless assigned directly in the Create job call) use the /api2/v1/projects/{projectUid}/jobs/{jobUid} endpoint.

The ID of the Provider that is inserted in the call can be obtained in two ways:

Notify Assigned Users

The job UID can then be used as an optional parameter in /api2/v1/projects/{projectUid}/jobs/notifyAssigned along with the emailTemplate parameter representing the ID of the email template to be used. This can be obtained from the Phrase UI or by using /api2/v1/emailTemplates.

This is where the translator would start to work in their profile just as if the Phrase UI was being used. After the job is finished, the PM in charge receives a notification, and the next part of the scenario is initiated. A callback can be intercepted via webhooks to automatically start the next part of the scenario but this will not be addressed in this example.

Step 3: Download Translated File, Set Project to Completed

The API call /api2/v1/projects/{projectUid}/jobs/{jobUid}/targetFile with the parameter jobUid can be used to retrieve the translated content.

Once the job in the project is completed, use the /api2/v1/projects/{projectUid}/setStatus with the mandatory parameters project and status to change the status of the entire project to Completed. This change is a manual one, but if Project Status Automation is used, the status will be changed automatically. It is also possible to wait for a webhook and initiate other actions based on the callback received.