You start by connecting to a Beebox project. Upon connection you obtain a session token. This token is included with all subsequent calls.
URL
(GET) http://localhost:8089/api/connect?project=&login=&pwd=&waitsecs=&connector=&version=PARAMETERS
The url parameters are:
project | The identifier of the project to connect to. You can find this id in the project settings page: |
login | You can create credentials individually per each project. Go to the project "Settings", then select "Connectors & API" and create login/password. These credentials can access data in the specific project and basic API methods only. Typically, these credentials would are perfect for CMS (Content Management System) connectors. Alternatively, you can use the administrator credentials. In that case you need to follow special rules. |
password |
|
waitsecs | Optional number. Default is 10. Indicates the timeout in seconds for this call. Purpose: Whenever the Beebox executes automated operations, it blocks login attempts. This parameter indicates how long the login method waits before it returns an error. |
connector | Free text that identifies your connector. For example “Drupal by xy” or “Magento”. Keep it a short product name. |
version | Free text containing the version number of your connector. For example "1.1.0". |
RESULTS
The API returns a session token which you include with all subsequent API calls.
It is important to verify the HTTP status code. If authentication succeeds, the method returns HTTP code 200 (success). All other HTTP codes point to an error.
If the server is busy due to a running server operation, the method will wait for the amount of seconds specified in the “waitsecs” parameter. If the server is still busy after this period, the method fails with an error id "BUSY". In that case please wait a few seconds and retry.
HTTP status codes
With every API call you need to check the HTTP error code. 200 and 204 equals success. All other codes point to an error.
DISCONNECTING
Always invalidate your token when you no longer need it. Failing to do so may put on hold automatic operations.
See API - Disconnect.