Integración API

En este artículo trataremos todos estos aspectos relacionados con la Integración API:

• Activación
• Documentación
• Entorno de prueba (SandBox)
• Gestión de claves API
• Despliegue a producción

Importante: Este artículo trata sobre la integración API central que permite acceder a los datos de los empleados en Kenjo. Esta API es diferente a la API pública utilizada en la página de empleo.

Activación

Para solicitar la activación de la API en tu cuenta de Kenjo, sólo hay que ir a Configuración > Integraciones y deslizar el botón junto a Claves API.

La activación corre a cargo de nuestro equipo de Soporte, por lo que hay que presionar en el boton verde para enviar la notificación.

Documentación

Mientras esperas a que nuestro equipo de soporte procese la solicitud, puede ser un buen momento para repasar nuestra documentación sobre la API. Allí encontrarás toda la información que necesitas para trabajar con esta función y todos los endpoints disponibles.

Dado que nuestro equipo mejora constantemente la API, esta documentación se actualiza a menudo. Es aconsejable consultarla regularmente para asegurarse de tener la última versión.

Entorno de prueba (SandBox)

Dado que los desarrolladores de tu equipo probablemente necesitarán probar la integración, podemos proporcionarles un entorno de prueba (sandbox) donde puedan ejecutar todas las pruebas necesarias sin comprometer los datos de la cuenta real. 

El uso de un entorno de prueba es muy recomendable antes de habilitar la integración de la API en la cuenta real de Kenjo. Si deseas disponer de un entorno de prueba, coméntaselo al equipo de soporte y te indicarán cómo hacerlo.

Gestión de claves API

Una vez aprobada la solicitud de activación de API, sigue estos pasos para generar una nueva clave de API:

Inicia sesión en su cuenta de Kenjo y ve a Ajustes > Integraciones > API. Te darás cuenta de que ahora tienes una opción de Ajustes donde antes no había nada:

Al hacer clic en Ajustes, se redireccionará a la pagina de Configurar claves API.

Para generar la primera clave API, haz clic en GENERAR NUEVA API KEY. Puedes generar hasta 5 claves con diferentes niveles de acceso.

Cada clave de API requiere:

• Alias: Para identificar y gestionar fácilmente tus claves API, proporciona un alias o nombre único para cada clave durante el proceso de generación.
• Nivel de acceso: Define el nivel de acceso que tendrá esta la clave API. Asegúrate de especificar los Permisos personalizados y las restricciones asociadas a esta clave. Por defecto, cada clave API tendrá acceso a los endpoints de empresa, oficina, departamentos, empleado, equipo, área, calendario y campos personalizados.

Importante: Antes de guardar, asegúrate de copiar la clave API en un lugar seguro. Una vez guardada, la clave API dejará de ser visible por motivos de seguridad.

Despliegue a producción

Una vez que hayas terminado de usar el entorno de prueba, no dudes en ponerte en contacto con nosotros en [email protected] para solicitar la activación de la API en tu cuenta de Kenjo.

Nota: Por favor, entiende que una vez habilitada la integración API en tu cuenta de Kenjo, el uso y acciones relacionadas son de tu exclusiva responsabilidad. Por lo tanto, recomendamos proceder con cautela y realizar pruebas únicamente en un entorno de prueba (SandBox).