Welcome to version 2 of the Wordbee Translator API. Version 2 will gradually replace the existing System API. You can of course use both at the same time.
| Info |
|---|
This API is close to final release. Some documentation is still missing. |
...
Any user you have created in your platform can be authorized to access the API. Which data an authorized user can read or write strictly depends on the user profile and the enabled access rights. As a general rule, a user can only access data he/she can also access in the web interface: A translator will only be able to retrieve information on his/her jobs, a manager can interact with projects and an administrator would be able to manipulate any data.
The advantage of this user based approach is that you can hand out API credentials to different users without putting at risk the integrity and security of your data.
Activation
Before someone can use the API for your Wordbee Translator platform you need to activate:
...
You can view all authorized users and revoke access from Settings > Developer API.
URL
The API root URL is:
| Code Block |
|---|
https://www.wordbee-translator.com/api |
Authentication
To use the API, the user first has to obtain a token. Submit this call:
| Code Block |
|---|
POST https://www.wordbee-translator.com/api/auth/token {"accountid": "MyCompany", "key": "XXX"} => returns token (string) |
Parameter accountid is the ID users have to fill in when logging online. It typically is an abbreviation of your company name.
Include this HTTP header with all subsequent API calls:
| Code Block |
|---|
X-Auth-Token YYY |
To disconnect (optional), use:
| Code Block |
|---|
PUT https://www.wordbee-translator.com/api/auth/token/invalidate |
Note: A token automatically expires after a period of inactivity.