Vea cómo utilizar el módulo de API de Integración y automatice aún más sus procesos.
- ¿Qué es el módulo de API de Integración?
- ¿Cómo utilizar la API de Integración?
- Preguntas Frecuentes (FAQ)
¿Qué es el módulo de API de Integración?
El módulo API Integration fue desarrollado para atender los escenarios en los cuales es necesario automatizar la gestión de los registros del Checklist Fácil utilizando una API. Con esta solución, usted puede integrar el sistema con cualquier otra plataforma y realizar diversas acciones, como:
- Generar tokens;
- Buscar, insertar y actualizar datos de registro;
- Buscar historial de aplicaciones;
- Registrar webhooks y mucho más.
¿Cómo utilizar la API de Integración?
Para consumir los datos de la API de Integración, usted necesita tener acceso a la documentación del módulo y tener su Llave de API a mano.
Para acceder a la documentación, es necesario estar logueado en Checklist Fácil. Inicie sesión y haga clic en el enlace: Acceder a la documentación oficial
Para facilitar la comprensión, ejemplificaremos el uso a partir del registro de unidades. Recuerde que las demás posibilidades pueden ser consultadas en la documentaón oficial.
Para listar las unidades registradas, consulte la documentación para obtener el método HTTP y la URL que se utilizarán, de acuerdo con el ejemplo a continuación:
Con esta información, usted puede crear su solicitud en herramientas como Postman, seleccionando el método HTTP e informando la URL completa.
De esta forma, usted realizará la solicitud de listado de las unidades con éxito:
Para cualquier solicitud de lista en la API, usted obtendrá dos propiedades principales:
- data: de tipo array, donde se muestran los objetos de retorno de la lista solicitada.
- meta:de tipo objeto, que contiene información sobre la paginación de los resultados, como:
- currentPage: la página consultada en el momento.
- lastPage: la última página que contiene registros.
- perPage: número de registros por página.
- total: total general de registros.
Observación: Todos los listados de la API están paginados. Es fundamental prever esta estructura al consumir los datos para garantizar que toda la información sea procesada correctamente.
Preguntas Frecuentes (FAQ)
1. ¿Qué métodos HTTP son compatibles?
La API es compatible con los métodos estándar del mercado: GET para consultas, POST para la creación de nuevos registros, PUT para actualizaciones y DELETE para eliminaciones.
2. ¿Puedo probar la API antes de programar?
Sí, usted puede utilizar herramientas como Postman para simular las solicitudes y visualizar los retornos antes de iniciar el desarrollo en su software.
3. ¿Qué sucede si no informo la página en la consulta?
En caso de que el parámetro de página no sea enviado, Checklist Fácil siempre devolverá automáticamente los datos correspondientes a la primera página de resultados.
❓Tem dúvidas? Entre em contato com nosso time de suporte.