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.

 

¿Como puedo probar la API de BrickControl?

Para probar la API de BrickControl vamos a utilizar un software cliente de REST desde el que podrás realizar todas las pruebas que quieras fácilmente.  Este es un mecanismo para probar los Webservices.
Cuando los vayáis a utilizar de verdad, para realizar una integración con otros software, podéis utilizar cualquier lenguaje de programación:  .NET, Java, Objective C…

– Instalar Google  Chrome
– Instalar la extensión de Google Chrome Advanced REST client
– Iniciar “Advanced REST client”

– A continuación os aparecerá el programa “RESTClient” que vamos a utilizar para realizar las pruebas:

 

¿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/

 

Ejemplos

Leer datos de BrickControl

Ejemplo 1. Obtener una lista de los clientes que tienes en BrickControl sin filtros y paginado del 1 al 10 (sólo obtienes los 10 primeros clientes)
  • Method: GET
  • URL: https://brickcontrol.com/api/v3/BrickControlRest.svc/Clients/getList?searchText=|NULL|&begin=1&end=10
  • Click botón “Send” y esperar a que se traigan los datos.
Ejemplo 2. Obtener el cliente con código 2
  • Method: GET
  • URL: https://brickcontrol.com/api/v3/BrickControlRest.svc/Clients/get?id=2
  • Click botón “Send” y esperar a que se traigan los datos.
Ejemplo 3. Obtener el número de clientes que tienes en BrickControl filtrando por la palabra “juan”
  • Method: GET
  • URL: https://brickcontrol.com/api/v3/BrickControlRest.svc/Clients/count?searchText=juan
  • Click botón “Send” y esperar a que se traigan los datos.
Ejemplo 4. Obtener el número de clientes que tienes en BrickControl sin filtrar por nada
 
  • Method: GET
  • URL: https://brickcontrol.com/api/v3/BrickControlRest.svc/Clients/count?searchText=|NULL|
  • Click botón “Send” y esperar a que se traigan los datos.

 

Guardar datos en BrickControl

Ejemplo 1. Crear un cliente nuevo en BrickControl
  • Method: POST
  • URL: https://brickcontrol.com/api/v3/BrickControlRest.svc/Clients/save
  • Payload: En el payload tienes que copiar y pegar el JSON con los datos del cliente que quieres crear.

Ver ejemplo de un JSON para crear un nuevo cliente

  • Click botón “Send” (y esperar a que se graben los datos)
    Ahora puedes observar en BrickControl que el nuevo cliente se ha creado correctamente.

Nota:

  • Si quieres crear más clientes puedes ir cambiando cualquier valor del JSON, y ejecutar el botón “Send” y se irán creando nuevos clientes.

 

Ejemplo 2. Modificar un cliente ya existente en BrickControl

Para modificar un cliente ya existente en BrickControl el mecanismo es exactamente igual que al crear un nuevo cliente con la única diferencia que en el JSON en el campo “Id” debes escribir el código identificador del cliente que quieres modificar.
En este ejemplo vamos a modificar el CIF y el teléfono del cliente insertado anteriormente.  En nuestro caso el identificador que el sistema había asignado al cliente anterior es el 16 (id=16), en vuestro caso el identificador puede ser distinto.

  • Method: POST
  • URL: https://brickcontrol.com/api/v3/BrickControlRest.svc/Clients/save
  • Payload: En el payload tienes que copiar y pegar el JSON con los datos del cliente que quieres modificar.

Ver ejemplo de un JSON para modificar un cliente ya existente

  • Click botón “Send” (y esperar a que se graben los datos)
    Ahora puedes observar en BrickControl que cliente se ha modificado correctamente.

 

Borrar datos en BrickControl

Ejemplo 1. Borrar el cliente con un código determinado

Para ejecutar este ejemplo, primero debes crear un cliente en BrickControl.  Debes fijarte en el código de cliente que le ha asignado BrickControl al cliente que has creado (el código entre corchetes [xx]). En este ejemplo vamos a borrar el cliente con código 16.

  • Method: DELETE
  • URL: https://brickcontrol.com/api/v3/BrickControlRest.svc/Clients/delete
  • Payload: Debemos escribir entre comillas el código del objeto que queremos borrar, en este ejemplo el código 16.

  • Click botón “Send” (y esperar a que se traigan los datos)

Ahora puedes ver la información que te ha devuelto la llamada al web service donde te indica si el borrado del cliente ha tenido éxito.