API Basics

Two Use Cases

BeLazy's API offer you two use cases within a single REST API. The two use cases of the API are clearly marked in the API reference.

"This operation is applicable when your system is acting as a BMS." refers to the BMS Integration use case.

"This operation is applicable when your system is a proprietary vendor portal." refers to the Project Ingestion use case.

Feature Parity

At BeLazy we take developer experience and extensibility very seriously. BeLazy's API aims to offer feature parity with the integrations we offer out of the box. If you need some functionality but cannot find it, get in touch using the Contact us form on the belazy.cat website.

Base Path

The base path of the BeLazy REST API is https://api.belazy.cat/api. You can see the relative (and absolute) URLs of the various API endpoints in the API reference.

Authentication/Authorization

In order to authenticate and authorize the incoming API requests BeLazy uses Apikey authorization. This means that you have to include an Authorization HTTP header along with your request, the content of which should be Apikey {your_access_token}, where your_access_token is the token generated on the BeLazy user interface, in the Api access tokens command of the profile menu.

Rate Limiting

We would like to provide a reliable service for all of our customers, therefore we apply rate limiting (also known as "throttling") to prevent malicious usage causing service outages. The limit currently in place lets you issue 100 requests per minute. You will see an error message if you reach this limit.