Overview of XTM Connect SDK
XTM Connect SDK is available as both SOAP and REST APIs. SOAP is currently in maintenance-only mode. You can find more information about the REST API at https://api.xtm-cloud.com/rest-api/.
If you wish to test the XTM Connect SDK, contact our Sales team. They can set up a sandbox environment and provide you with the requisite URLs.
Contact Sales
XTM Sales Team sales@xtm.cloud.
The web services are generally designed to be passive. They do not need to know anything about the customer service and will only call the customer service after specified workflow events. The web services primarily respond to calls from customers.
For file transfers, the web services can accept a URL, encoded BASE64 binary information, or an MTOM file attachment.
There are two key concepts for web services:
Project – this is the overall project that is created.
Job – a project may comprise one or more language pairs (source language and target language). Each language pair is called a “job” within a project.
The following steps describe how to use XTM Connect SDK:
Create a project. Certain data is mandatory to create a project, and other data is optional.
Table 1. : Mandatory and optional data for project creationMandatory data
Optional data
Source files.
Source language.
Target languages.
Customer.
Project name.
Due date.
Workflow.
Description.
Reference ID.
Use Google MT.
Check if the project or a particular job has finished its analysis stage.
Get the job/project metrics if required. Depending on the metrics, the Customer may decide not to proceed with the project.
Assign Linguists.
Start or delete the project.
Check the status of the project.
Generate the target file,
XLIFFor QA report, and download it (you can either request a URL or MTOM download).
Note
Steps 2. to 5. are optional because the Project Manager can perform these tasks from within XTM Cloud.