When you send a file to translate, the Beebox will translate according to the configured workflow and automation. By default, the translation will be into all project target languages.
Next to the source file, you can optionally send JSON formatted "instructions" to the Beebox:
- Specify the target languages of translation. For example: Translate file into French only ("fr").
- Specify a deadline of translation.
- Specify text alignment options in case you also sent the translated file version.
- Specify any meta information to include with files.
Read: When to use instructions?.
...
(PUT) /api/files/file?token=&locale=&folder=&filename={source file name}.beebox...
The API method, parameters, and result is identical to that for sending source files.
Instruction file name and location
The instructions are stored are JSON formatted. Let us suppose the source file is folder\document-200.xml. In that case, the instructions file must be named folder\document-200.xml.beebox . Append “.beebox” to the original file name like in the example below:
To request a translation into one specific target language, send a JSON like below with name "document-200.xml.beebox":
...
Use the standard API call to send: /api/files/file?token=...&filename=document-200.xml.beebox&locale=en
Instructions format
| Include Page | ||||
|---|---|---|---|---|
|
Common use cases
Read more about when to use instructions
...
Serialize JSON to UTF-8 when adding to the HTTP request body.
ADDITIONAL INFORMATION
More information is found at:
| Child pages (Children Display) |
|---|
Beebox also supports folder level instruction files:
...