Overview of XTM Connect

XTM Connect SDK is available as both SOAP and REST APIs. SOAP is currently in maintenance only mode. You can find more information about REST API at https://api.xtm-cloud.com/rest-api/.

If you wish to test XTM Connect SDK please contact sales@xtm.cloud who can set up a sandbox environment and provide you with the requisite URLs.

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 mainly respond to calls from the customer.

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 the 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:

  1. Create a project. Certain data is mandatory to create a project and other data is optional.
    Mandatory data

    • Source files
    • Source language
    • Target languages
    • Customer
    Optional data

    • Project name
    • Due date
    • Workflow
    • Description
    • Reference ID
    • Use Google MT
  2. Check if the project/or particular job has finished its analysis stage.
  3. Get the job/project metrics if required. Depending on the metrics the Customer may decide not to proceed with the Project.
  4. Assign linguists.
  5. Start or delete the Project.
  6. Check the status of the Project.
  7. Generate the target file, XLIFF or QA report and download it (you can either request URL or
    MTOM download).

Steps 2. to 5. are optional since the project manager can perform these tasks from within XTM.

The diagram below shows a typical integration.

XTM Connect SDK