Skip to main content
Version: 📄 MX

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.com.mx

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 RFC o cpnId de empresa a activar.

Puedes elegir el "topic" que necesitas recibir, tanto para POST o para PUT

Noticifaciones base

  • Documento
  • Stock
  • Producto
  • Variante
  • Precio

Notificaciones Tienda en Linea

  • Producto Web
  • Detalle Colección
  • Colección
  • Venta Online

Otras Notificaciones

  • Pagos
  • Documento Declarado
  • Courier Externo
note

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