Versions Compared

Key

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

These are the credentials you use to login to the Beebox user interface. The credentials procure unrestricted access to all Beebox projects and all data.

  • Unlimited access to all Beebox projects, including administration
  • For internal use only. Never disclose admin credentials to third parties.

 

You can use your admin credentials for the Beebox API and get unlimited access. Although, you should always use standard or advanced credentials unless these are too limited.

The credentials are the same you use when logging into the Beebox UI:

 

Use API

Never disclose your admin credentials to third parties.

Create API session to access a specific project

If you want to work with content and data of one specific project, do include the project ID when connecting. 

The method returns the session token. You can type this into a web browser to see the token.

 

creating a session.

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

 

Note: Since we specified We specify the admin login, the admin password and the project key, . With the session allows access and manipulation of data in this specific project only.

 

Use API to access all projects including Beebox

obtained session key, all API methods will relate to that project.

Create API session to access any project and for administration

For unlimited access to all projects and Beebox administrative API calls, you would omit the project ID in the url: 

Code Block
http://localhost:8089/api/connect?project=&login=myadmin&pwd=adminpassword

 

This returns a project independent session token:

Image Added

This token can be used for creating new projects, deleting projects, access the Beebox log and any other project independent operation.

In order to manipulate a specific project during your session, you need to append the project ID to the token and use this with your project specific API calls.

Code Block
{token}*{project id}

For example:

Code Block
localhost:8089/api/files/file?token=611b27e4-9d09-40ba-b7a8-794aaeff4b07*f167bce4-66d8-4bc1-8ed6-4c9086ae7a46&filename=  .....

 

Next steps: Read about connecting to the Beebox to acces project data in the API reference.