Primeros pasos con la API

¿Qué es la API de BrickControl?

BrickControl dispone de una API en la que a través de Web Services se puede integrar con otros productos fácilmente.

Con la API de BrickControl se pueden leer, insertar, actualizar y borrar datos de BrickControl desde otros programas de una manera muy sencilla.

Los Web Services que utiliza BrickControl son REST.

¿Qué datos debo rellenar para hacer una petición a la API?

Para hacer una petición a la API debes rellenar los siguientes parámetros:

URL: Es la dirección web que apunta al método que queremos llamar.

Method: GET, POST o DELETE.

Header: El header siempre es el mismo para todas las peticiones, será
exactamente el siguiente, cambiando las xxxxxxxxx por vuestra apiKey. (Vuestra apiKey nos la debéis solicitar mediante nuestro soporte):

Content-Type: application/json

Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Payload: En los métodos POST y DELETE se deberá pasar un texto JSON con el objeto que queremos guardar o borrar. En el método GET no hay que pasar este parámetro.

Puedes comprobar si el JSON que estás enviado tiene un formato correcto en este enlace:

https://jsonformatter.curiousconcept.com