Translate File
POST | https://[api | sandbox].strakertranslations.com/v3/translate/file
The translate/file method is a POST and is used to submit a new API file job. The parameter that must be passed is a source_file. The parameters that need to be passed can be modified by Straker Translations project managers.
Request Headers
API requests are authenticated by the Bearer Token.
Content-Type: multipart/form-data; charset=uft-8;
Authorization Brearer {access_token}
Request Body
Content-Disposition: form-data; name="title" api test job Content-Disposition: form-data; name="sl" English Content-Disposition: form-data; name="tl" Chinese_Simplified Content-Disposition: form-data; name="source_file" It may have taken him a few years, but Danny Lee has broken through on the PGA Tour. Content-Disposition: form-data; name="token"
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| title | string | A title for the job. | Yes |
| sl | string | The language code of the source language, e.g. “English”. Please see the Language list. | Yes |
| tl | string | The language code of the target languages, e.g. “Spanish,French”. Please see the Language list. | Yes |
| source_file | file | An HTTP post of a source file is XML file only. To view the structure of the XML, please see XML Structure. | Yes |
| callback_uri | string | A URL that the API will post content and status updates to. | |
| token | string | A token you can use as a reference on your end, e.g. this may be the ID of a content object in your system. | |
| workflow | string | A workflow for the job. “TRANSLATION” is set by default. Please see Workflows. | |
| reserved_word | string | A comma-separated list of keywords. Reserved Words are terms that you DO NOT want translated. | |
| priority | integer | API Priority is an optional parameter for relative jobs priority. Please see Priority. Faster turnarounds based on a set number of words can be controlled by Straker on a case by case basis. | |
| purchase_order | string | Purchase order is an optional parameter for the purchase order number (PO) with which the job is associated. Purchase orders will be displayed on invoices. | |
| notes | string | Notes you can reference for a job | |
| custom_field_values | string |
Custom field values is a comma-separated list of values assigned to custom fields defined in our CRM and need to be sent in order - please see Custom fields. The maximum length of the comma-separated list of values is 255 characters. |
|
|
group_by_key
|
string (maximum of 50 characters) | Group by key is a string value for the purpose of grouping a number of API file jobs into a single Translation Job. | |
|
translation_notes
|
string or JSON |
FREE TEXT OR JSON for notes for each Target Language. These notes will be visible to the translator. |
|
|
job_notes
|
string or JSON |
FREE TEXT OR JSON for notes for each Target Language. These notes will be only visible to the Project Manager. |
|
|
job_reference
|
String (maximum of 100 characters) |
A reference to identify the job on your systerm |
|
|
validator_email
|
string |
Multiple validator emails e.g. firstvalidator.com, secondvalidatoremail.com (maximum of 2) |
Optional |
| cc_email | string |
A comma-separated list of multiple email addresses that will be receiving a quote e.g. test1@email.com, test2@email.com (maximum of 4) |
Response Example
{
"job_key": "BCC3C60D-82F7-44A3-B541DAACB3B70D2E",
"message": "Thank you, your job has been submitted successfully.",
"success": true,
"wordcount": 0
}
Translate Text
POST | https://[api | sandbox].strakertranslations.com/v3/translate/text
The translate/text method is a POST and is used to submit a new API text job. The parameter that must be passed is a payload. The parameters that must be passed can be modified by Straker Translations project managers.
Request Headers
API requests are authenticated by the Bearer Token.
Content-Type: application/x-www-form-urlencoded; charset=utf-8;
Authorization: Bearer {access_token}
Request Body
title=job+title&sl=French&tl=English&payload=The+content+you+wish+translated
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| title | string | A title for the job. | Yes |
| sl | string | The language code of the source language, e.g. “English”. Please see the Language list. | Yes |
| tl | string | The language code of the target languages, e.g. “Spanish,French”. Please see the Language list. | Yes |
| payload | string | The content you wish to have translated. | Yes |
| callback_uri | string | A URL that the API will post content and status updates to. | |
| token | string | A token you can use as a reference on your end, e.g. this may be the ID of a content object in your system. | |
| workflow | string | A workflow for the job. “TRANSLATION” is set by default. Please see the Workflow. | |
| reserved_word | string | A comma-separated list of keywords. Reserved Words are terms that you DO NOT want translated. | |
| priority | integer | API Priority is an optional parameter for relative jobs priority. The values for this field can be 1 (lowest) to 5 (highest). Priority 5 can also allow for faster turnarounds of an agreed set number of words controlled by Straker on a case by case basis. Please see Priority. | |
| purchase_order | string | Purchase order is an optional parameter for the purchase order number (PO) with which the job is associated. Purchase orders will be displayed on invoices. | |
| cc_email | string | A comma-separated list of multiple email addresses that will be receiving a quote e.g. test1@email.com, test2@email.com (maximum of 4) |
Response Example
{
"job_key": "BCC3C60D-82F7-44A3-B541DAACB3B70D2E",
"message": "Thank you, your job has been submitted successfully.",
"success": true,
"wordcount": 0
}
Comments
0 comments
Article is closed for comments.