En este artículo te explicamos qué es una interfaz de programación de aplicaciones (API) pública, para qué sirve una API de informes personalizados y cómo generar credenciales de API para ella.

¿Qué es una API pública en Personio?

Las API posibilitan el intercambio de datos entre Personio y otros servicios o herramientas. De este modo, puedes crear conexiones entre Personio y tus propias bases de datos, o configurar integraciones con otras soluciones de software disponibles en Personio Marketplace.



Personio ofrece varias API públicas: la API de reclutamiento, la API de informes personalizados y las cuatro API de datos de empleados (empleados, ausencias, registro de jornada y documentos).

¿Para qué sirve la API de informes personalizados?

En concreto, la API de informes personalizados te permite crear análisis e informes más avanzados. 

En función del endpoint, esta API te permite:

• • • • • Recuperar una lista de todos los informes personalizados existentes en tu cuenta de Personio (endpoint getReports).
        • Recuperar una lista de todas las columnas de la tabla de informes existentes (endpoint GetColumns).
        • Recuperar los datos de un informe personalizado determinado en formato JSON (endpoint GetReportData).

En otras palabras, la API de informes personalizados te permite fusionar los datos de RR. HH. de Personio con otros conjuntos de datos, guardarlos en un almacén de datos y procesarlos posteriormente con una herramienta de inteligencia empresarial (BI, por sus siglas en inglés).

Ejemplo
Puedes usar la API de informes personalizados para extraer datos históricos de los empleados o también para extraer el número de horas extras que tus empleados han trabajado en un mes concreto.

Nota
La API de informes personalizados no permite crear o editar un informe personalizado ya existente.

Generar las credenciales de API

1. 1. Ve a Ajustes > Integraciones > Credenciales de API.
   2. Haga clic en Generar nueva credencial.
   3. Aparecerá la barra lateral Añadir nueva credencial. En el campo Nombre, introduce un nombre descriptivo (por ejemplo, Credenciales de los informes personalizados) para las credenciales de la API.
   4. Si fuera necesario, selecciona una integración en el menú desplegable Integración. Si no, selecciona Otro.
   5. Selecciona la casilla Leer para la API Informes personalizados.
      

      Consejo
      Encontrarás más información sobre las diferentes casillas de verificación en el artículo Generar y administrar credenciales de API.

   6. Haz clic en Generar nueva credencial.
   7. Aparecerá un mensaje confirmando que se han creado las nuevas credenciales de API.

   

   Consejo
   Como alternativa, también puedes activar el endpoint de lectura del informe personalizado para una credencial de API ya existente. Ve a Ajustes > Integraciones > Credenciales de API, haz clic en una credencial y selecciona la casilla Informes personalizados.
   

   Nota
   Si el endpoint de lectura está habilitado, se pueden recuperar todos los informes existentes. Además, la sección de atributos legibles del empleado para la API de datos del empleado no se tendrá en cuenta para el endpoint de informes personalizados. Todos los atributos añadidos a un informe personalizado se podrán recuperar a través del endpoint si está habilitado para las credenciales correspondientes, sin importar si el atributo se ha incluido en la lista blanca o no. 

    

   Documentación técnica

   Encontrarás toda la documentación de nuestra API de informes personalizados junto con los endpoints y los tutoriales técnicos, así como información sobre los datos concretos que se transfieren en nuestro Centro de desarrollo.