Endpoints

Esta sección describe las especificaciones de la API para interactuar con las ventas del POS y los asientos contables.

La API, a través de algunos de sus endpoints (detallados en el siguiente capítulo), proporciona los siguientes servicios o funcionalidades:

• Login o autorización: POST
• Consultar ventas: GET
• Agregar ventas: POST
• Actualizar ventas: PUT
• Eliminar ventas: POST
• Iniciar proceso asíncrono para agregar ventas: POST
• Iniciar proceso asíncrono para eliminar ventas: POST
• Consultar procesos asíncronos para agregar y/o eliminar ventas: GET
• Consultar proceso asíncrono específico para agregar o eliminar ventas: GET
• Consultar listado de asientos contables: GET
• Actualizar estado de ledger header: PATCH

Estas operaciones permiten gestionar eficazmente los datos de ventas y tener visibilidad sobre las ventas del POS y asientos contables.

Cada llamada a la API está paginada para manejar conjuntos grande de datos. Adicionalmente, los endpoints para cargar y eliminar ventas está limitada a 500 ventas.

Además, cabe destacar que TODAS las consultas a cualquiera de los endpoints de la API deben ser necesariamente secuencias.

Para la carga o inserción de ventas del POS, quien realiza la integración debería procesar los datos de sus ventas de modo de transformarlos al formato JSON requerido por la API que se detalla a continuación.

La API devolverá códigos de estado HTTPS apropiados y mensajes de error para varios escenarios de error. Los códigos de estado comunes incluyen:

- `400 Solicitud Incorrecta`: Datos de entrada no válidos.

- `401 No Autorizado`: Token de autenticación faltante o no válido.

- `403 Prohibido`: El usuario no tiene permiso para realizar la operación.

- `404 No Encontrado`: El recurso solicitado no fue encontrado.

- `500 Error Interno del Servidor`: Ocurrió un error inesperado en el servidor.

EndPoints de la API relacionados a Ventas y Contabilidad

Login o autenticación

- Endpoint: https://connectapi.nubceo.com/authenticate

- Método: POST

- Descripción**: Autenticación para obtener token.

Body:

{

"API\_KEY": "xxxxx",

"API\_SECRET": "xxxxxx"

}

Esto genera un token y es el que debe ir como Bearer Token en el header de Authorization de cada petición que se envíe a la API.

Response:

{

"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcGlrZXkiOiJsdWNpYW5vLWJlcm5pIiwiYXBpa2V5X2lkIjoiNCIsInVzZXJfaWQiOm51bGwsImlhdCI6MTcyMjg4Mzg4MywiZXhwIjoxNzIyODg3NDgzfQ.HIPIe3J3-CTIytPotDyPzIM3aNv-CLURD7\_mYhaPCCA"

}