Home

Carlos Rojas edited this page Oct 19, 2016 · 19 revisions
Clone this wiki locally

Bsale

Bsale API

El equipo de Bsale ha puesto a disposición de la comunidad de desarrolladores una API, la cual permite acceder a un conjunto de métodos orientados a facilitar la integración, desde sistemas externos hacia Bsale. Estos métodos permitirán obtener información desde Bsale o enviar información hacia la aplicación. Así, por ejemplo, se puede obtener la lista de productos, generar notas de venta, obtener los documentos generados, etc..

Esta API permite llamadas del tipo REST y utiliza JSON para el envío y recepción de información.

Convenciones utilizadas

  • Peticiones sobre SSL
  • Se usan sustantivos, no verbos.
  • Se utilizan 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.
  • Respuesta en una estructura JSON con los atributos en camelCase.
  • todas las respuestas son en ingles (atributos y mensajes).
  • Manejo de versiones en la url.
  • Manejo de errores y estados en las respuestas.
  • Paginacion de la respuesta JSON.
  • Permitir acceder a las relaciones de un recurso a través de la variable expand en una sola petición.
  • Permitir devolver solo los atributos requeridos a través de la variable fields.
  • 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.

Si necesitas aprender como trabaja Bsale puedes revisar nuestros videos de capacitación