Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Access to limited set of API methods. Perfect for CMS or other data source connections.
  • Can safely be disclosed to third parties such as customers.

Create credentials

Credentials are created individually per project. When connecting to the API, the caller can only interact with data from the project.

(1) Login to the Beebox UI.

(2) Select a project and click the "Connectors & API" tab:



(3) Click "Edit" and toggle the switch to "ON": Fill in a login and password.

Make sure to tick the "Standard connector" option.

 

Warning

Make sure to tick the "Standard connector" option.

 

 

(4) Click "Ok" to save your credentials

Once saved you will see the unique identifier of the project. You need this when connecting.


Connect to the API

You are now ready to connect to the API, example:

Code Block
http://localhost:8089/api/connect?project=f167bce4-66d8-4bc1-8ed6-4c9086ae7a46&login=mylogin&pwd=superpassword

You can test this in a web browser. The result is the session token:

...