¿Cómo activar la API?
Siga los pasos a continuación para activar y configurar la integración de la API de Key Predict, con el fin de conectar su herramienta y automatizar el inicio de las sesiones de evaluación y la recuperación de los resultados.
⚠️ Importante: solo los administradores de cuenta disponen de los derechos necesarios para configurar la página “Integraciones”.
1. Activar el acceso a la API
Para utilizar la API, la opción Webservice debe estar activada en su cuenta.
Puede enviar una solicitud desde: Gestión de la cuenta > Contratos > Opciones > "Solicitar activación"
👉 También puede ponerse en contacto con su responsable de cuenta o con el soporte de Key Predict para activar la opción. La opción Webservice es una funcionalidad de pago.
Una vez que la opción esté disponible en su cuenta, puede activarla desde Gestión de la cuenta > Integraciones. En la lista de integraciones disponibles, seleccione Key Predict y haga clic en "Activar".
2. Definir sus credenciales de integración
Durante la configuración, debe introducir:
- Login API
- Contraseña API (se recomiendan un mínimo de 12 caracteres)
👉 Estas credenciales sirven para proteger los intercambios entre Key Predict y su herramienta y para autenticar las llamadas y las notificaciones. Pueden definirse libremente o ser proporcionadas por su herramienta.
3. Configurar las URL de notificación
Puede introducir (campos opcionales):
- URL Webservice – Sesión de evaluación iniciada: URL del webhook utilizada para enviar una notificación cuando un candidato inicia una sesión de evaluación (véase la sección 10 de la API – Notification on assessment started).
- URL Webservice – Sesión de evaluación finalizada: URL del webhook utilizada para enviar una notificación cuando un candidato finaliza una sesión de evaluación (véase la sección 9 de la API – Notification on assessment completed).
- Expiración del token: cuando esta opción está activada, el token de autenticación expira a los 3 días para reforzar la seguridad.
Estas URLs corresponden a los endpoints de su herramienta que recibirán automáticamente las notificaciones de eventos.
Deben ser:
- proporcionadas por su equipo técnico o su herramienta
- capaces de recibir solicitudes HTTP (webhooks)
Si no dispone de estas URLs, póngase en contacto con su equipo técnico o su proveedor.
🔒Nota sobre la expiración del token
Se trata de una opción de seguridad avanzada. Si la expiración está activada:
- el token se convierte en temporal
- debe ser renovado automáticamente por su sistema
Esta opción solo se recomienda si dispone de los recursos técnicos necesarios para gestionar la renovación automática del token.
4. Funcionamiento general
Una vez configurada la integración:
- Su herramienta puede iniciar evaluaciones
- Key Predict gestiona el envío y el seguimiento de las pruebas
-
Hay dos modos de funcionamiento disponibles:
- con notificaciones (recomendado): su herramienta recibe automáticamente las notificaciones de los eventos (inicio, finalización)
- sin notificaciones: su herramienta puede consultar la API para recuperar la información
- Los resultados pueden recuperarse y utilizarse en su entorno
Para más información, consulte nuestra documentación técnica basada en el protocolo REST (Representational State Transfer).
Casos de uso
Nuestra API permite integrar las evaluaciones de Key Predict en un ATS, un HRIS o cualquier otra aplicación empresarial. A continuación se presentan los escenarios de integración más habituales.
Caso de uso 1: Crear un candidato desde su ATS
Este escenario permite sincronizar automáticamente un candidato creado en su ATS con Key Predict.
Cómo funciona:
- Cuando se crea un candidato en su ATS, llame al método create/candidate.
- Transmita los datos del candidato (apellido, nombre, correo electrónico, idioma, etc.).
- Key Predict crea automáticamente el participante y devuelve su identificador único.
- Conserve este identificador en su ATS para utilizarlo en las operaciones siguientes.
Endpoints relacionados:
- create/candidate
- update/candidate
Ejemplo de uso:
Cuando un el responsable de contratación crea un candidato en su ATS, este se crea automáticamente en Key Predict sin intervención manual.
Caso de uso 2: Invitar a un candidato a realizar una evaluación
Este escenario permite enviar una o varias evaluaciones directamente desde su ATS.
Cómo funciona:
- Recupere la lista de evaluaciones disponibles en su cuenta.
- Seleccione el o los cuestionarios que desea enviar.
- Llame al método candidate/invite.
- Key Predict envía automáticamente la invitación al candidato.
- El candidato recibe un correo electrónico que le permite acceder a sus evaluaciones.
Endpoints relacionados:
- assessment/list
- candidate/invite
Ejemplo de uso:
El responsable de contratación hace clic en "Invitar a realizar una evaluación" desde la ficha del candidato en su ATS y selecciona el cuestionario Profil Pro 2 en una lista desplegable. La invitación se envía inmediatamente al candidato sin salir de la herramienta.
Caso de uso 3: Permitir al candidato iniciar su evaluación desde su plataforma
Este escenario permite al candidato acceder a su evaluación directamente desde su ATS o su portal de candidatos.
Cómo funciona:
- El candidato ha recibido una invitación para realizar una evaluación.
- Su aplicación recupera la URL segura de sesión de evaluación generada por Key Predict.
- Desde su portal de candidatos o su ATS, el usuario hace clic en "Iniciar evaluación".
- Su sistema redirige automáticamente al candidato hacia la plataforma de evaluación de Key Predict.
- Una vez finalizada la evaluación, Key Predict puede notificar a su aplicación mediante la URL "Assessment Completed".
Endpoints relacionados:
- URL de sesión de evaluación devuelta en el momento de la invitación
- Notificación Assessment Completed
Ejemplo de uso:
Desde el espacio del candidato en su ATS, un botón "Iniciar evaluación" permite al candidato acceder directamente a su cuestionario sin tener que buscar el correo electrónico de invitación.
Caso de uso 4: Recuperar los resultados y mostrar los informes en su plataforma
Este escenario permite consultar los resultados de las evaluaciones directamente desde su ATS o su HRIS.
Cómo funciona:
- El candidato finaliza su evaluación.
- Key Predict envía una notificación a su URL "Assessment Completed".
- Su sistema recupera automáticamente los resultados disponibles.
- Los informes en PDF o HTML pueden descargarse o mostrarse directamente en su plataforma.
- Los responsables de contratación o los managers consultan los resultados sin necesidad de conectarse a Key Predict.
Endpoints relacionados:
- assessment/completed
- assessment/result
Ejemplo de uso:
Cuando un candidato finaliza su Profil Pro 2, aparece automáticamente un botón "Ver informe" en la ficha del candidato, lo que permite al responsable de contratación consultar los resultados directamente desde su ATS.
Caso de uso 5: Comparar candidatos mediante puntuaciones de adecuación
Este escenario permite automatizar el cálculo de las puntuaciones de adecuación de los candidatos en relación con un puesto o un proyecto.
Cómo funciona:
-
Cree una campaña de evaluación mediante la API definiendo:
- las evaluaciones que se utilizarán,
- el modelo predictivo asociado al puesto o al proyecto,
- Asocie la campaña a una etapa de su oferta de empleo o de su proyecto en su ATS.
- Cuando un candidato alcanza esta etapa, su ATS activa automáticamente su inscripción en la campaña y el envío de las evaluaciones.
- Una vez completadas las evaluaciones, Key Predict calcula automáticamente las puntuaciones de adecuación a partir del modelo predictivo asociado a la campaña.
- Su ATS recupera las puntuaciones mediante la API y puede mostrarlas en la ficha del candidato o en la lista de candidaturas.
Endpoints relacionados:
- campaign/creation-link
- campaign/list
- campaign/candidate/report
Ejemplo de uso:
Crea una campaña "Comercial Senior" asociada a un modelo predictivo. Cuando un candidato alcanza la etapa "Evaluación" en su ATS, las pruebas se envían automáticamente. Una vez disponibles los resultados, la puntuación de adecuación se calcula y se muestra directamente en su pipeline de contratación para facilitar la comparación de candidatos.
Caso de uso 6: Recuperar la ficha Insight y la Talent Map
Este escenario permite mostrar en su ATS o en su HRIS un enlace seguro hacia la ficha de participante de Key Predict. Desde esta ficha, los responsables de contratación o los equipos de RR. HH. pueden consultar el Insight del participante y su Talent Map, según las funcionalidades activadas en la cuenta.
Cómo funciona:
- El candidato o colaborador realiza las evaluaciones requeridas.
- Una vez disponibles los resultados, su sistema recupera el enlace seguro hacia la ficha de participante.
- Este enlace se muestra en su ATS o en su HRIS, por ejemplo desde la ficha del candidato o del colaborador.
- Al hacer clic en este enlace, el usuario accede a la ficha de participante de Key Predict, que centraliza los resultados disponibles: Insight, informes detallados, Talent Map.
- Los responsables de contratación, managers o equipos de RR. HH. pueden consultar esta información sin necesidad de buscar al participante manualmente en Key Predict.
Endpoints relacionados:
- campaign/candidate/report
Ejemplo de uso:
El responsable de contratación consulta el informe BF5 o Perfil Pro 2 directamente desde su ATS sin necesidad de abrir otra aplicación.