Lo que la API permite hacer (visión general)
Repaso no técnico de los datos y acciones disponibles a través de la API Shyfter: departamentos, horarios, fichaje, empleados, facturación y exportaciones.
La API Shyfter está organizada por grandes ámbitos, que retoman los módulos que ya conoces en la aplicación. Según los permisos de tu token, puedes consultar estos datos (lectura) y, si el token no es de solo lectura, actuar sobre ellos (creación, modificación). Esto es lo que cada ámbito pone a disposición, sin entrar en lo técnico.
Por dónde empezar
Ante todo, la API ofrece un punto de entrada que enumera los permisos de tu token y las funcionalidades activas en la cuenta. Es el buen reflejo de partida: sabes de inmediato a qué tiene derecho tu token y si es de solo lectura.
Como la mayoría de los datos están vinculados a un departamento, primero recuperas la lista de los departamentos a los que tu token tiene acceso, y luego indicas el departamento correspondiente en cada llamada.
Los ámbitos disponibles
- Departamentos: la lista de tus establecimientos y departamentos accesibles. Es la base para dirigirte luego a los datos correctos.
- Horario: tus turnos y tu planificación. Consulta el horario publicado y, según los derechos, crea o modifica turnos.
- Fichaje: el seguimiento del tiempo de trabajo. Puedes recuperar los fichajes, fichar la entrada o la salida de un empleado, y anular un fichaje en curso.
- Empleados: la información de tus empleados, con sus contratos, sus competencias y su gestión de ausencias.
- Secciones: las secciones de tus establecimientos (bar, cocina, sala, sección de tienda...), útiles para organizar el horario.
- Atributos: los atributos personalizados que has definido para enriquecer tus datos.
- Facturación: el envío y la consulta de tu facturación, para comparar con tus horas trabajadas y tus costes.
- Exportaciones: la recuperación de tus datos en forma de exportación, práctica para alimentar un reporting u otro software.
Los códigos de gestoría están, por lo demás, alineados entre los turnos y los fichajes, para un envío coherente hacia la nómina.
Dónde encontrar el detalle
La documentación completa (cada ámbito, cada campo) y una guía de implementación están disponibles directamente en la plataforma Open API, destinadas a tus equipos técnicos o a tu integrador. Este artículo da la visión general; la documentación en línea da las instrucciones precisas.
Lo que tu token puede realmente ver o modificar depende de los permisos que le hayas concedido y de si es o no de solo lectura. En caso de duda, comprueba primero sus permisos.