Introduccion API BOS
El sistema Gestion BOS cuenta con una API REST que permite la integracion con otros sistemas o sitios webs. Se utiliza JSON para la transmicion de los datos y contamos con librerias en distintos lenguajes de programacion (.NET, PHP, etc.) para su utilizacion.
La API cuenta con diversos metodos que permiten realizar consultas y operaciones con los distintos objetos del sistema. Estos metodos se encuentran definidos y documentados para su consulta por parte de los desarrolladores.
Autenticacion
Una vez habilitado el acceso de API es necesario contar con la URL y un KEY que nos permitira autenticar los pedidos. La libreria APIClientBOS se encargara de autenticar todos los pedidos y operaciones que se realicen utilizando el KEY provisto. La autenticacion se realiza mediante la solicitud de un token que permite realizar consultas y operaciones a traves de la API por un tiempo determinado. Transcurrido este periodo la libreria misma se encarga de gestionar un nuevo token de autorizacion.
Operaciones
Existes cuatro tipos de operaciones basicas que se pueden realizar para los metodos de la API y son las siguientes:
GET
Las operaciones GET son consultas que devuelven informacion. Por ejemplo si se realiza una operacion de GET al metodo “Productos/ListaProductos.aspx” vamos a obtener una lista de productos filtrados de acuerdo a los parametros enviados.
POST
Las operaciones POST se utilizan para realizar altas de objetos. Por ejemplo si hacemos una operacion de POST al metodo “Pedidos/Pedido.aspx” y le enviamos como parametro todos los datos de un pedido, vamos a realizar el alta del mismo en el sistema.
PUT
Las operaciones PUT se utilizan para actualizar los datos de un objeto. Por ejemplo si hacemos una operacion de PUT al metodo “Productos/Producto.aspx” y le enviamos como parametro los datos de un producto, vamos a realizar un actualizacion del mismo en el sistema.
DELETE
Las operaciones DELETE se utilizan para eliminar un objeto. Por ejemplo si hacemos una operacion de DELETE al metodo “Productos/ProductoCategoria.aspx” y le enviamos como parametro el identificador de la categoria, vamos a realizar una baja de la misma en el sistema.
Metodos
La API cuenta con varios metodos agrupados por modulos, a continuacion se detallan las referencias de los mismos:
API Client
Descarga de las librerias de la API Client, consulta sobre el modo de uso y ejemplos: APIClient: Uso y ejemplos