API e integraciones

¿Cómo usar la API de kawak®?

Conoce como adquirir la API y aprende a usar su documentación y endpoints.

Actualizado el 11 de julio de 2024                       Tiempo estimado de lectura: 1 minuto

🤔 Sabes ¿Qué es una API y cómo funciona? aprende los conceptos básicos aquí 👈

Con el fin de que puedas integrar kawak® con otras aplicaciones o sistemas de información, podrás utilizar nuestra API de integración. Para lograrlo realiza los siguientes pasos:

A. Solicitud del servicio

Para adquirir este servicio adicional, comunícate con nuestra área comercial, más información ⬅️ .

B. Credenciales de acceso

Una vez adquirido el servicio crearemos las credenciales (email, password e instancia) de acceso a la API de tu empresa, usando la cuenta de correo que hayas suministrado previamente. A dicha cuenta te llegarán las credenciales de acceso.


C. Documentación

En este documento: https://api.kawak.com.co/docs/index.html encontrarás todos los puntos finales o endpoints de nuestra API, disponibles para tus integraciones agrupados por módulo. Ten en cuenta que así no tengas un módulo licenciado puedes acceder a su documentación.

Encontrarás endpoints de diferentes tipos: GET, POST, PUT, DELETE una vez identificado el endpoint requerido haz clic sobre este y verás los parámetros y mensajes de respuesta del mismo. Por ejemplo, este endpoint es para la creación de una acción de mejora 👇

TipoEndpoint1

TipoEndpoint2

D. Autenticación: Cómo obtener el bearer token

A través de las credenciales de acceso suministradas y el endpoint /login, podrás generar el token de autorización (bearer token) que te permitirá utilizar los endpoints de la API.

Para ello podrás utilizar una herramienta de API como Postman o Insomnia, o también a través del botón que encuentras en la página de documentación de la API: https://api.kawak.com.co/docs/index.html al dar clic en el botón verás la información que está en la imagen que se muestra a continuación 👇, donde vas a ingresar las credenciales (email, password e instancia) de acceso.

Enpoint3
E. Listo para usar los endpoints

Mediante el bearer token obtenido en el punto anterior, podrás usar los diferentes endpoints de la API de kawak®:

  • Endpoint que te permite obtener procesos
  • Endpoint para creación de planes de acción de acciones de mejora
  • Endpoint que te permite obtener todos los datos asociados a los campos que se completan al crear documentos
  • Endpoint que te permite obtener todos los datos de una planeación
  • Endpoint que te permite obtener el reporte y el análisis de todas las acciones de mejora
  • Endpoint que te permite obtener los datos de los indicadores para un período y fecha de corte. También puedes obtener la dependencia (de que indicador depende), incidencia (en cual o cuales indicadores incide) y el objetivo relacionado a la planeación (objetivo estratégico de la planeación a que el indicador está asociado).

En este endpoint 👇 por ejemplo está consultando todo el listado de documentos.

Endpoint4

El único parámetro que esté endpoint requiere es la autorización, que corresponde al bearer token.

🔔 Recuerda comunicarte con nuestra área comercial para adquirir este servicio,  más información ⬅️