Pro API

The Pro API lets you interact with your brewerys' data, i.e. to enable custom build dashboards.

Setup

To enable the Pro API: Got to your brewerys admin page (https://bricks.bierbot.com/#/brewery/admin), locate the "Pro-API" section and toggle the enable toggle to on. The Pro-API key and API key become available. The latter is the normal API key you've used for setting up all your Brick. The first one is an additional API key we need for communicating with the API.

Pro-API config menu

Usage

Note: This requires at least a PRO membership.

If you're missing an endpoint, please reach out using the blue feedback button, the contact form or the forum.

List all devices

List all devices (their IDs) of a brewery.

GET/api/devices

Query parameters

Response

200

OK

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('/api/devices', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

Get device details

Get details for a given device.

GET/api/device

Query parameters

Response

200

OK

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('/api/device', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}