Getting started with the BrickControl’s API

What is the BrickControl API?

BrickControl’s API easily integrates with other products through Web Services.

Our API allows you to read, insert, update and delete data you have entered into BrickControl, easily and directly from any other programs.

BrickControl uses  REST as its software architectural style for Web Services.

What information do I need to fill in, so i can make an API request?

To make a request to the API you must fill in the following parameters:

URL: This is the web address pointing to the method we want to call.

Method: GET, POST or DELETE.

Header: The header should always the same for all requests.
It should be exactly tlike he following, only changing xxxxxxxxx for your apiKey. (Your apiKey must be requested through our support page):

Content-Type: application/json

Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Payload: In the POST and DELETE methods, a JSON text must be passed on with the object to be saved or deleted. This parameter does not have to be passed on using the GET method.

You can check if the JSON file you are sending is formatted correctly at this link:

https://jsonformatter.curiousconcept.com