Where is the API located?
Most API methods commence with:
http://localhost:8089/api/....
When accessing the API from a different computer you will need to replace "localhost" by the server public IP address, such as:
http://111.111.222.111:8089/api/....
The port number may be different in your Beebox installation and you may have to use HTTPS instead of HTTP. This can be configured in the Internet Information Services (Microsoft IIS) management tool: Change Port and SSL
How do I work with the API?
Start with creating a session by calling the /api/connect method. You require a login, a password and a Beebox project ID (the project you want to work with in the session).
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?
If you administer the Beebox you create the credentials yourself. Otherwise, the Beebox administrator will provide this information to you.
There are three types of credentials. Standard credentials give you limited control over a single project, Advanced credentials let you call a few more API methods and Admin credentials give you full and unlimited access to all Beebox data. Creating credentials.
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.
Continue reading: Obtaining credentials