Introduction

The User API is a restful web API. It can be programmed with any development language

Where is the API located?

Please ask Wordbee for the API end point.

In this documentation, we use the following notation:

   https://{domain:port}/api/....

Find your end point

How do I work with the API?

Start with creating a session using the /api/connect method. You obtain a session token.

Include this token with all subsequent API calls such as when you want to send content to translate or retrieve completed translations.

At the end close the session with /api/disconnect.

Where do I get credentials from?

Credentials are the account ID, login and password of a Wordbee Translator user.

The API works with the very same credentials a user fills in to login online. Each Wordbee Translator user has his/her own set of credentials.

Please ask the administrator of the target Wordbee Translator platform. The administrator may create a new login or hand out an existing.

Check back that this login gives access to the functionality you want to integrate. If it does not, you will receive an error message when connecting.

What data can I access with the credentials?

You can exclusively access data that is disclosed to the user who owns the credentials.

What this data is depends on the profile and access rights that are configured in the Wordbee Translator platform. Some functionality in this API may be available to certain users only. In other words, the security framework of Wordbee Translator applies to this API.

Once my product is released, which credentials do I use?

Your product should display a login dialog where a user fills in his/her private Wordbee Translator credentials.

You should not hard-code logins or passwords into your software!

If your software "remembers" credentials you must strongly encrypt them.

What is GET, PUT, POST and DELETE?

When we describe an API method we always indicate the, so called, HTTP request methods or verbs. Make sure that your HTTP requests use the right verb.

What else should I know?

You should know that we have an excellent technical support 

If you encounter difficulties or find errors, contact support at http://wordbee.zendesk.com