API - Connect

You start by connecting with 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.

URL

(GET) http://{server:port}/api/connect?account=&login=&pwd=&domain=&ui=

PARAMETERS

The url parameters are:

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.
pwd	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: InstantTranslation : Unlocks the MT Hive API methods.
ui	Optional. The user interface language. Default value is "en" if not specified. Permitted values are: en (English) fr (French) de (German) es (Spanish) ja (Japanese) nl (Dutch) 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.

It is important to systematically verify the HTTP status code. If authentication succeeds, the method returns HTTP code 200 (success). All other HTTP codes point to an error.

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".

EXAMPLE

{
  "token": "14c78440-7d7a-4504-9f46-4fa322fecdb5",

  "platform": "Alpha Ltd.",
  "company": "John Howard Translations",
  "user": "John Howard",
  "ui": "en"
}

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.

Make sure to read this section: Error Handling.

DISCONNECTING

Always invalidate your token when you no longer need it. Failing to do so may put on hold automatic operations.

See API - Disconnect