Introducción API BOS
El sistema Gestión BOS cuenta con una API REST que permite la integración con otros sistemas o sitios web. Se utiliza JSON para la transmisión de los datos y contamos con librerías en distintos lenguajes de programación (.NET, PHP, etc.) para su utilización.
La API cuenta con diversos métodos que permiten realizar consultas y operaciones con los distintos objetos del sistema. Estos métodos se encuentran definidos y documentados para su consulta por parte de los desarrolladores.
Autenticación
Una vez habilitado el acceso de API es necesario contar con la URL y una CLAVE que nos permitirá autenticar los pedidos. La librería APIClientBOS se encargará de autenticar todos los pedidos y operaciones que se realicen utilizando el KEY provisto. La autenticación se realiza mediante la solicitud de un token que permite realizar consultas y operaciones a través de la API por un tiempo determinado. Transcurrido este periodo la libreria misma se encarga de gestionar un nuevo token de autorización.
Operaciones
Existen cuatro tipos de operaciones básicas que se pueden realizar para los métodos de la API y son las siguientes:
CONSEGUIR
Las operaciones GET son consultas que devuelven información. Por ejemplo si se realiza una operación de GET al método ” Productos/ListaProductos.aspx ” vamos a obtener una lista de productos filtrados de acuerdo a los parámetros enviados.
CORREO
Las operaciones POST se utilizan para realizar altas de objetos. Por ejemplo si hacemos una operación de POST al método ” Pedidos/Pedido.aspx ” y le enviamos como parámetro todos los datos de un pedido, vamos a realizar el alto del mismo en el sistema.
PONER
Las operaciones PUT se utilizan para actualizar los datos de un objeto. Por ejemplo si hacemos una operación de PUT al método ” Productos/Producto.aspx ” y le enviamos como parámetro los datos de un producto, vamos a realizar una actualización del mismo en el sistema.
BORRAR
Las operaciones DELETE se utilizan para eliminar un objeto. Por ejemplo si hacemos una operación de DELETE al método ” ProductoCategoria.aspx ” y le enviamos como parámetro el identificador de la categoría, vamos a realizar una baja de la misma en el sistema.
Métodos
La API cuenta con varios métodos agrupados por módulos, a continuación se detallan las referencias de los mismos:
Cliente API
Descarga de las librerías de la API Client, consulta sobre el modo de uso y ejemplos: APIClient: Uso y ejemplos