Open API

Cómo usar la documentación de la API de ClayHR

La información detallada está disponible en https://clayhr.readme.io

Introducción

Las API de ClayHR proporcionan opciones de integración sólidas para interactuar con los datos, de forma muy similar a la aplicación web. Puede obtener sus claves de API en el portal de ClayHR y empezar a usar los servicios de inmediato. Las llamadas siguen la arquitectura y la nomenclatura RESTful, y se protegen mediante https, al igual que las llamadas desde los navegadores web.

La clave de API tiene el mismo acceso de seguridad que el usuario al que pertenece la clave.

Obtención de la clave de API y el identificador de usuario

Las API de ClayHR aceptan una clave de API a través del encabezado de autorización de solicitud HTTP. Cada usuario puede obtener la clave de la API de autorización (también llamada x-api-key) desde la aplicación siguiendo estos pasos:

Coloca el cursor sobre tu registro de usuario en la esquina superior derecha y haz clic en Mis integraciones.

En la página Mi integración, cambie a Administrar claves de API y, a continuación, haga clic en el botón Generar claves de API.

Al hacer clic en el botón Generar clave de API, aparecerá una nueva sección con la clave de API. Puede copiar la clave después de hacer clic en el enlace «mostrar».

Puedes coger tu ID de usuario desde la misma pantalla de integración

Pruebe un punto final de API

Cuando visitas https://clayhr.readme.io verás varios puntos finales de la API en el panel izquierdo de la página.

Puede navegar a cualquiera de estos puntos finales y probarlo insertando la clave de API y el ID de usuario y otros valores necesarios para obtener la respuesta de esa API.

Por ejemplo: para obtener la lista de habilidades, navegue hasta el enlace de habilidades del panel izquierdo y complete la identificación de usuario y la clave de API que obtuvo de su solicitud.

Después de completar la clave de API y el ID de usuario, pulse [¡Pruébalo!] Botón y recibirás la respuesta de esa API (como se muestra en la siguiente captura de pantalla).