Home
Carlos Rojas Latorre edited this page Aug 28, 2018
·
2 revisions
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.
- 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
- Home
- Comenzando a utilizar la API
- Ejemplos en C#
- Ejemplos en Java
- Ejemplos en PHP
- Ejemplos en Ruby
- Ejemplos en Visual Basic
- Herramientas útiles
- Atributos dinámicos
-
Clientes
- Estructura JSON
- GET lista de clientes
- GET único cliente
- GET contactos
- GET contacto único
- POST un contacto
- DELETE un contacto
- GET direcciones
- GET dirección única
- POST una dirección
- PUT una dirección
- DELETE una dirección
- GET atributos
- GET cantidad de clientes
- GET documentos pendientes de pago
- POST un cliente
- PUT un cliente
- DELETE un cliente
- Códigos tributarios
- Condiciones de venta
- Descuentos
- Despachos
- Devoluciones
-
Documentos
- Estructura JSON
- GET lista de documentos
- GET único documento
- GET resumen
- GET detalles
- GET detalle único
- GET referencias
- GET referencia única
- GET impuestos
- GET impuesto único
- GET vendedores
- GET costos de una venta
- GET atributos dinámicos de un documento
- GET cantidad de documentos
- POST un documento
- DELETE un documento
- Formas de pago
- Impuestos
- Listas de precio
- Monedas
- Pagos
- Productos
- Stocks
- Sucursales
- Tipos de despacho
- Tipos de documento
- Tipos de producto
- Usuarios
- Variantes