Configuración de la API de asistencia de Personio

 

Este artículo te servirá de guía para utilizar la API de asistencia de Personio con integraciones y herramientas externas. La API te permite (con ayuda de un profesional informático) recuperar los datos en bruto de los períodos de asistencia registrados por los empleados en Personio, así como importar los tiempos de asistencia en la plataforma.

Para poder utilizar la API de asistencia necesitas estar suscrito al plan Enterprise de Personio. Si quieres obtener más información o modificar tu suscripción, envíanos un correo electrónico a upgrade@personio.de.

Ten en cuenta que la integración de la API de asistencia debe ser realizada por un informático profesional. Encontrarás la documentación técnica de nuestra API con todos los endpoints y los tutoriales técnicos correspondientes en https://developer.personio.de/.

 

Autenticación y uso

Tanto el endpoint GET como el endpoint POST están protegidos y solo se puede acceder a ellos mediante autenticación a través de un token de seguridad.Para obtener más información, haz clic aquí.

A continuación, te explicamos las diferencias entre los endpoints GET y POST:

  • GET / company / attendances
  • POST / company / attendances

 

1. Obtener la información de asistencia de los empleados (GET) 

Endpoint /company/attendances
Método GET
Descripción

Los tiempos de asistencia de los empleados se consultan desde este endpoint.

Puedes utilizar saltos de página para mostrar la información de asistencia en varias páginas y tener una mejor visión general. Además, puedes filtrar la información recuperada por períodos de tiempo, seleccionar solo a determinados empleados y/o incluir a los empleados inactivos en tu búsqueda.

 

Filtros

A continuación, encontrarás una lista de filtros que podrás utilizar para obtener información relativa a las asistencias:

Filtro Tipo Formato Obligatorio General Descripción
start_date cadena de texto AAAA-mm-dd   Primer día del período que se va a consultar, que también se incluirá en los resultados.
end_date cadena de texto AAAA-mm-dd   Último día del período que se va a consultar, que también se incluirá en los resultados. Si el primer y el último día son iguales, solo se mostrará la asistencia de ese día.
employees array [int, ...] no  

Para mostrar únicamente la información de asistencia de determinados empleados, usa el ID de empleado de Personio.

Si no se establece ningún filtro, se recuperará la información de asistencia de todos los empleados.

limit entero   no 200

Limita los conjuntos de datos de salida utilizando el filtro limit.

Si, por ejemplo, quieres limitar el conjunto de datos de asistencia mostrados a 200, establece un limit de "200".

Entonces solo se mostrarán 200 filas.

offset entero   no 0

Reduce el conjunto de datos mostrados por la API con el filtro offset.

Si, por ejemplo, quieres consultar los datos de asistencia a partir de la fila 300, establece un offset de "300".

Entonces tu consulta solo devolverá los resultados a partir de la fila 300 y hasta el límite establecido (ver arriba).

Limitar las consultas contribuye a reducir los tiempos de carga y requiere menos memoria.

Define además los atributos que se transmitirán a través de la API en Ajustes > API > Acceso > Atributos permitidos.

 

Parámetros para recuperar los períodos de asistencia

A continuación, te mostramos los diferentes atributos y tipos que puedes utilizar para recuperar los períodos de asistencia.

Atributo Tipo Formato Descripción
date cadena de texto AAAA-mm-dd Día de asistencia
start_time cadena de texto hh:mm Hora de inicio
end_time cadena de texto hh:mm Hora de finalización
break entero   Minutos de descanso
comment cadena de texto   Descripción o comentario sobre la asistencia
is_holiday booleano [true/false] ¿La asistencia fue en un día festivo o no? 
is_on_time_off booleano [true/false] ¿La asistencia fue en un día en el que se registró una ausencia "real" (la ausencia es tiempo libre)? Si es así, Personio considerará las horas de asistencia como horas extras.
employee entero   ID de empleado 

 

2. Añadir información de asistencia de los empleados (POST) 

Endpoint /company/attendances
Método POST
Descripción Los tiempos de asistencia de los empleados se añaden utilizando este endpoint. Se pueden añadir asistencias para uno o varios empleados simultáneamente. El paquete de datos enviado debe ser una lista de períodos de asistencia en forma de array.

Los filtros para añadir información de asistencia son idénticos a los que se utilizan para recuperar esta información y los encontrarás más arriba.

 

Parámetros para añadir períodos de asistencia 

A continuación, te mostramos los diferentes atributos y tipos que puedes utilizar para añadir períodos de asistencia.

Atributo Tipo Formato Descripción
date cadena de texto AAAA-mm-dd Día de asistencia
start_time cadena de texto hh:mm Hora de inicio
end_time cadena de texto hh:mm Hora de finalización
break entero   Minutos de descanso
comment cadena de texto   Descripción o comentario sobre la asistencia
employee entero   ID de empleado

 

Validación

En los siguientes casos se producirá un fallo de validación y los datos no se guardarán en Personio:

  • El start_time y el end_time del período de asistencia coinciden con otro período de asistencia que ya está registrado en Personio para el mismo día.
  • No se han encontrado empleados para el filtro que se ha establecido.
  • El paquete de datos está incompleto (faltan los parámetros start_time o end_time).

 

¿No has encontrado lo que buscabas?

¡Nosotros te ayudamos! Coméntanos tus dudas y te responderemos lo antes posible.

Enviar una solicitud

Comentarios

0 comentarios

El artículo está cerrado para comentarios.

    Temas de este artículo