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

get

List all devices (their IDs) of a brewery.

Query parameters

apikeystringOptionalExample: 3iHUDCxPfoo42ZyrmmAz

proapikeystringOptionalExample: aAaAa4242CxPfoo42ZyrmmAz

Responses

200

OK

application/json

Responseobject

get

/api/devices

HTTPcURLJavaScriptPython

GET /api/devices HTTP/1.1
Accept: */*

200

OK

{}

Get device details

get

Get details for a given device.

Query parameters

apikeystringOptionalExample: 3iHUDCxPfoo42ZyrmmAz

proapikeystringOptionalExample: aAaAa4242CxPfoo42Z42

deviceidstringOptionalExample: RqUiO7eDRe3xKyKgXtwc

Responses

200

OK

application/json

Responseobject

get

/api/device

HTTPcURLJavaScriptPython

GET /api/device HTTP/1.1
Accept: */*

200

OK

{}