You start by connecting to a Beebox projectwith valid Wordbee Translator user credentials which are the same that you use when connecting to Wordbee Translator online. Upon connection you obtain a session token. This token is included with all subsequent calls.
...
account | Mandatory. The Account ID. This is the same value as entered when logging in online. |
login | Mandatory. The User Login. This is the same value as entered when logging in online. |
passwordpwd | Mandatory. The User Password. This is the same value as entered when logging in online. |
domain | Mandatory. Specifies the Wordbee Translator functionality you want to work with. These value are supported:
|
ui | Optional. The user interface language. Default value is "en" if not specified. Permitted values are:
The API will localize certain strings like language names accordingly in results. NOTE: The list above may change. Navigate to www.wordbee-translator.com to see all currently available language options in the top navigation bar. |
RESULTS
The API returns a JSON object which includes the session token for all subsequent API calls.
...
| token | The session token which you must include with all subsequent API calls. | ||
| platform | The owner of the Wordbee Translator instance. | ||
| company | The company name of the connected user. | ||
| user | The name of the connected user. | ||
| ui | The user interface language. If the language specified during connection is invalid, this defaults back to "en". | InstantTranslation | Included if you connected to this application domain. See xxx for description. |
EXAMPLE
...
| Code Block |
|---|
{
"token": "14c78440-7d7a-4504-9f46-4fa322fecdb5",
"platform": "Alpha Ltd.",
"company": "John Howard Translations",
"user": "John Howard",
"ui": "en",
"InstantTranslation": {
"urlTerms": null,
"deadlineMandatory": true,
"deadlineMinLeadHours": 12
}
} |
ERROR HANDLING
If the HTTP status code is different from 200, the connect method failed. What exactly went wrong is detailed with the HTTP error result.
...