La API Integration fue desarrollada para atender los escenarios donde necesitamos automatizar la gestión de los registros del Checklist Fácil empleando una API. Para consumir los datos, asegúrese de tener acceso a la documentación y a su Clave de API a mano.
- Ejemplo: Consultar registro de unidades
- Estructura del objeto de retorno (Data y Meta)
- Gestión de paginación
Ejemplo: Consultar registro de unidades
En estos ejemplos vamos a considerar el registro de las unidades. Para traer las unidades registradas, deberá consultar la documentación de la API con la finalidad de obtener el método HTTP e URL a emplear en su consulta:
Con estas informaciones, ya puedes crear una requisición en Postman, seleccionando el método HTTP e informando la URL completa:
Estructura del objeto de retorno (Data y Meta)
Para toda requisición de listados en la API, obtendrás dos propiedades principales:
- Data: del tipo array donde muestra el objeto de retorno de la lista solicitada, con las propiedades específicas de cada caso.
- Meta: del tipo objeto donde se retornan las informaciones sobre la paginación de los resultados.
Gestión de paginación
Es fundamental comprender los campos del objeto Meta para navegar por los registros:
- currentPage: la página en la que estás consultando.
- lastPage: última página que contiene registros.
- perPage: número de registros retornados por página.
- total: total de registros independiente de la página consultada.
Nota: Todas las listas de la API siempre estarán paginadas, es importante comprender y anticipar su uso al consumir los datos.
❓Tem dúvidas? Entre em contato com nosso time de suporte.