Skip to main content
Version: 馃搫 PE

Webhooks

Bsale webhooks

El equipo de Bsale ha puesto a disposici贸n de la comunidad de desarrolladores un conjunto de notificaciones o Webhooks, la cual permite que puedas estar informado cuando en Bsale se ejecuten determinadas acciones, como la creaci贸n de un documento, la creaci贸n de un producto, la actualizaci贸n del stock, sus precios etc. Esto evitar谩 que tengas que estar preguntando cada cierto tiempo si algo ha cambiado en Bsale. Estas notificaciones o "callback麓s", son informadas mediante webhooks o tambi茅n conocidos como user-defined HTTP callbacks, a mediante un POST a una URL que configures para ello. De esta manera por ejemplo cada vez que en Bsale se cree un nuevo documento, te avisaremos mediante una llamada POST a la URL que definiste, con una estructura JSON que contiene la informaci贸n que te permitir谩 obtener el documento creado.

Con los datos enviados en el estructura JSON podr谩s llamar a nuestra API.

info

Url base para consumir las respuestas https://api.bsale.io

Convenciones utilizadas

  • Se solicita que la notificaci贸n POS sea sobre SSL.
  • Se usan sustantivos, no verbos.
  • Se utiliza dos urls base por recurso "/clients.json", "clients/1.json"
  • Siempre se usa el nombre del recurso en plural.
  • Se env铆a la url del recurso.
  • Manejo de versiones en la url.
  • Las fechas se trabaja como enteros, por ejemplo 1388545200 corresponde a la fecha 2014-01-01, la conversi贸n es realizada utilizando el [Tiempo Unix].

Estructura de notificaciones

  • cpnId Identificador 煤nico de la instancia (Empresa) en la cual se gener贸 la acci贸n.
  • resource Endpoint donde podr谩s leer el recurso modificado.
  • resourceId Identificador 煤nico del recurso modificado.
  • topic Informaci贸n respecto del tipo de recurso modificado (Documentos, Productos, variantes, stock, precios)
  • action Acci贸n ejecutada sobre el recurso. Para ello se utiliza RESTful como est谩ndar (POST, PUT o DELETE)
  • send fecha en formato de entero (UNIX)
tip

Algunas notificaciones contendr谩n estructuras JSON con campos extras como por ejemplo officeId, en el caso de creaci贸n de documentos.

Webhooks disponibles

Solicitar activaci贸n

Para solicitar la activaci贸n, puedes escribirnos a ayuda@bsale.app indicandonos la URL y el rut o cpnId de empresa a activar.

note

Los webhooks que se indiquen como beta, deben ser solicitados a ayuda@bsale.app su implementaci贸n