Work with Import and Export XLIFF APIs
Overview
Import and Export XLIFF API allows you to export the XLIFF template for engagements that are ready for translation and import the translated XLIFF file from the localization platform to the engagement.
Import XLIFF API
This API allows you to import XLIFF content for translations of engagements from your localization platform.
Request Method: post
Path: v1/localization/import
Params:
| name | type | required | description |
|---|---|---|---|
| file | File | true | the XLIFF file |
Response Structure:
- 201 - Created
- 432 - XLIFF parsing error
- 433 - Engagement id not found in XLIFF file
- 434 - Target language is not part of subscription's allowed languages
- 437 - Strategy is not valid
- 438 - XLIFF version is not supported
Export XLIFF API
This is an API for getting the XLIFF template for engagements that are ready for translation.
Request Method: get
Path: /v1/localization/export
Params:
| name | type | required | Default | description |
|---|---|---|---|---|
| version | File | false | 2.0 | The XLIFF version to be exported (default 2.0) |
| trgLang | string | false | Language codes | Target language to be included in XLIFF |
| strategy | string | false | html/contexual |
|
| engagementId | string | false | Only specific ID filter | |
| productKey | string | false |
Corresponding product key of the subscription |
|
| env | string | false | prod | int, QA, stage, prod |
| metadata | boolean | false | false | Indicates returning metadata only, without the engagement content. |
If the export operation is successful, the endpoint returns a zip file containing .xlf files as a binary stream (Content-Type: application/octet-stream). If the operation fails, it returns one of the following errors.
Response Error Status Codes:
- 435 - Engagement is not found
- 436 - Engagement has no content
- 437 - Strategy is not valid
- 438 - XLIFF version is not supported