This repository has been archived by the owner on Jun 8, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 32
API documentation
Giuseppe Silvano edited this page Nov 23, 2015
·
4 revisions
All the endpoints accept data as POST calls with Content-Type multipart/form-data.
The returned value is always a JSON.
$ curl 'http://localhost:8732/AutomationService/original2xliff' \
-F '[email protected]' \
-F 'sourceLocale=en-GB' \
-F 'targetLocale=it-IT'
{
"filename":"source.docx.xlf",
"xliffContent":"<?xml version=\"1.0\" encoding=\"UTF-8\"...
"isSuccess":true
}
Param | Description |
---|---|
documentContent | The binary content of the source file |
sourceLocale | The source language of the file in ISO 639 format |
sourceLocale | The target language of the file in ISO 639 format |
Field | Description |
---|---|
filename | The name of the XLIFF file returned |
xliffContent | The contents of the XLIFF file, in plain text |
isSuccess | True if everything is ok, otherwise false |
errorMessage | A description of the exception encountered; returned only if isSuccess is false |
$ curl 'http://localhost:8732/AutomationService/xliff2original' \
-F '[email protected]'
{
"filename":"source.out.docx",
"documentContent":"lbnRfVHlwZXNdLnhtbLWUy2rDMBBF94...
"isSuccess":true
}
Param | Description |
---|---|
xliffContent | The binary content of the XLIFF file |
Field | Description |
---|---|
filename | The name of the source file extracted |
documentContent | The binary content of the source file, Base64 encoded |
isSuccess | True if everything is ok, otherwise false |
errorMessage | A description of the exception encountered; returned only if isSuccess is false |
$ curl 'http://localhost:8732/AutomationService/xliff2source' \
-F '[email protected]'
{
"filename":"source.docx",
"documentContent":"UEsDBBQACAgIAM94akcAAAAAAAAA...
"isSuccess":true
}
Param | Description |
---|---|
xliffContent | The binary content of the XLIFF file |
Field | Description |
---|---|
filename | The name of the output file returned |
documentContent | The binary content of the output file, Base64 encoded |
isSuccess | True if everything is ok, otherwise false |
errorMessage | A description of the exception encountered; returned only if isSuccess is false |
This endpoint just "pings" the server. Example:
$ curl 'http://localhost:8732/test'
Server on
The XLIFF produced by MateCat Filters are fully compliant with the XLIFF 1.2 specification.
The only peculiarity is in the first two <file>
elements.
The first <file>
is used to carry the original document.
The second <file>
carries a manifest file with infos on the conversion steps performed.
Both don't contain translation units, they just contain the binary data of the respecteve files encoded in Base64.
They are needed by MateCat Filters to properly convert the XLIFF back to the original format.