Authentication

Bluebot APIs authenticate with API keys. Each key is generated in FloDash and is scoped to a single Organization — it can only access devices and data that belong to that organization.

Generating an API key

  1. Sign in to FloDash and switch to the organization you want the key to act on.
  2. Open the API Keys section in organization settings.
  3. Create a new key and choose the scopes/permissions it should have.
  4. Copy the key value — it is shown only once.

Scoping permissions

When you create a key, you select the permissions it carries. Endpoints check the key's scopes before responding, so a key without the required scope will receive a 403. Keep keys narrowly scoped to the actions a given integration actually needs.

Keys are also bound to one organization. Devices and data from other organizations are not visible to the key, even with broad scopes.

Sending the key

Pass the key on every request in the bluebot-api-key header.

bash
curl https://prod.bluebot.com/management/v1/organizations/mine \
  -H "bluebot-api-key: YOUR_API_KEY"