Conectar otros sistemas con la API abierta de RR. HH.
La API abierta de RR. HH. permite a otro sistema leer personas, asistencia, ausencias y nómina definitiva, y enviar marcaciones con una clave que usted crea. Los webhooks de RR. HH. le comunican los eventos.
Antes de empezar
- Debe ser propietario. Los gerentes no pueden crear claves, aunque tengan todos los permisos de RR. HH.
- RR. HH. debe estar activado.
Crear una clave
- Abra RR. HH. → Configuración de RR. HH. y, en Autoservicio y el equipo, seleccione API abierta de RR. HH..
- Marque La API abierta está activada y seleccione Guardar. Aparece la Dirección base.
- En Crear una clave, escriba Para qué (por ejemplo «gestoría de nómina»).
- En Puede, marque solo lo necesario: leer personas, leer asistencia, enviar marcaciones, leer ausencias, leer nómina definitiva, gestionar webhooks.
- Seleccione Crear la clave.
- Copie la clave ahora y entréguela al otro sistema. Solo se muestra una vez; Kluvan conserva únicamente un hash.
[SHOT hr-open-api-keys 1440x900]Captura de pantalla próximamente: Página API abierta de RR. HH.: activación, dirección base, dos claves con permisos, último uso y llamadas, botón Revocar y formulario Crear una clave
Añadir un webhook
- En Agregar un webhook, introduzca la URL de su sistema (debe empezar por https).
- Marque los eventos:
employee.created,employee.left,punch.recorded,leave.approvedypayroll.paid. Todos están marcados inicialmente. - Seleccione Agregarlo y copie el secreto de firma, que se muestra una sola vez.
- Consulte Envíos para ver lo enviado, su estado y número de intentos.
Conviene saber
- Claves independientes. Las claves de RR. HH. forman un sistema separado de las demás claves API de Kluvan y solo acceden a los datos de RR. HH. de su organización.
- Nunca leen datos bancarios, documentos ni datos biométricos. leer nómina definitiva devuelve únicamente procesos pagados, nunca borradores, sin IBAN ni número de cuenta.
- Seleccione Revocar para detener una clave inmediatamente. La lista muestra su último uso y número de llamadas.
- Una clave admite 10 llamadas por segundo, con ráfagas breves de hasta 60. El período consultado puede abarcar hasta 92 días.
- Las marcaciones enviadas por API se añaden como correcciones con el nombre de la clave como autor. Envíe cada una una sola vez: si se duplica, aparece dos veces en la hoja de horas y un gerente debe quitar una.
- Los webhooks se firman con el secreto (HMAC-SHA256 en la cabecera
X-Hr-Signature). Los envíos fallidos se reintentan durante aproximadamente un día; tras 20 fallos consecutivos, el webhook se desactiva hasta que lo reactive. - Aún no probado con un destino real: los envíos solo se han probado en nuestro entorno de pruebas. Compruébelos con su sistema antes de depender de ellos.
- La creación y revocación de claves y cada marcación enviada quedan en el historial de actividad.
- Para desarrolladores, la página enlaza la referencia técnica: Lea cómo llamarla.
¿Le resultó útil esta página?
Gracias. Su respuesta nos ayuda a mejorar esta página.
¿Todavía necesita ayuda?
Escríbanos por WhatsApp. Cuéntenos qué estaba haciendo y, si es un error, el código que sigue a # en el enlace.