Antes de empezar
Puede crear claves API para empleados o usuarios robot. Se trata de un código de identificación de un usuario (o desarrollador) que se utiliza para acceder a nuestras API. Las claves API se utilizan para hacer seguimiento y controlar el uso de la API. La clave API sirve, al mismo tiempo, como nombre de usuario único y como ficha secreta para la autenticación, y tiene asociado un conjunto de derechos de acceso.
Tenga cuidado con las autorizaciones que da para la clave y a quién transfiere el token. La persona que tenga este token puede obtener información que quizás sea confidencial.
Crear una nueva clave de API
Para crear una nueva clave de API, debe ir a la rueda dentada > Autenticación, SSO y API > Claves API. Si no tiene derechos de acceso, contacte con su administrador para que genere una clave API y, si usted es administrador sin acceso a las funciones, póngase en contacto con el servicio de soporte.
Haga clic en Generar una nueva clave API para crear una clave.
En la ventana de creación:
- Si es necesario, personalice el nombre que quiera asociar a esa clave.
- Seleccione los derechos que quiera asociar a esta clave (debe seleccionar una autorización aquí, pero después podrá editar todas las autorizaciones de la clave en las funciones, tal y como se indica más adelante).
- Introduzca un contacto técnico si tiene alguna pregunta sobre el uso de la clave API (debe introducir un contacto).
- Seleccione el uso que desea hacer de esta clave (debe marcar una de las opciones, bien para conectar un editor externo a través de esta clave, bien para utilizar esta clave internamente).
- Opciones avanzadas: puede personalizar la clave. Sin embargo, debe respetar el formato GUID (globally unique identifier), un identificador único con 16 bytes (ejemplo: [3F2504E0-4F89-11D3-9A0C-0305E82C3301]).
Una vez generada la clave, puede copiar esta clave colocando el cursor encima:
Editar los derechos asociados a una clave existente
Según cómo quiera utilizar su clave, tendrá que darle los derechos asociados.
Por ejemplo, si quiere recuperar los datos de un empleado de una sección específica del expediente de Portal RR. HH. de un empleado, tendrá que dar a su clave el derecho a ver esa sección.
Si quiere editar los derechos asociados a una clave, vaya a la administración de las funciones haciendo clic en el enlace azul «Administración de las funciones»:
Consejo: Si tiene Poplee Core HR y necesita restringir el acceso de la clave a solamente unos datos del expediente de Portal RR. HH., puede crear una sección concreta en Poplee Core HR y asignar derechos de visibilidad únicamente a esa sección. De esta manera, las personas que tengan el token de la clave de API podrán acceder solamente a esos datos.
Una vez creada la clave, podrá utilizar nuestras API. Para obtener más información sobre nuestras distintas API, consulte la documentación API.