Ce que l'API permet de faire (vue d'ensemble)

L'API Shyfter est organisée par grands domaines, qui reprennent les modules que vous connaissez déjà dans l'application. Selon les permissions de votre token, vous pouvez consulter ces données (lecture) et, si le token n'est pas en lecture seule, agir dessus (création, modification). Voici ce que chaque domaine met à disposition, sans entrer dans la technique.

Par où commencer

Avant tout, l'API propose un point d'entrée qui liste les permissions de votre token et les fonctionnalités actives sur le compte. C'est le bon réflexe de départ : vous savez immédiatement à quoi votre token a droit et s'il est en lecture seule.

La plupart des données étant rattachées à un département, vous récupérez d'abord la liste des départements auxquels votre token a accès, puis vous précisez le département concerné à chaque appel.

Les domaines disponibles

• Départements : la liste de vos établissements et départements accessibles. C'est la base pour cibler ensuite les bonnes données.
• Planning : vos shifts et vos horaires. Consultez le planning publié et, selon les droits, créez ou modifiez des shifts.
• Pointage : le suivi du temps de travail. Vous pouvez récupérer les pointages, pointer l'arrivée ou le départ d'un collaborateur, et annuler un pointage en cours.
• Collaborateurs : les informations de vos employés, avec leurs contrats, leurs compétences et leur gestion d'absences.
• Sections : les sections de vos établissements (bar, cuisine, salle, rayon...), utiles pour organiser le planning.
• Attributs : les attributs personnalisés que vous avez définis pour enrichir vos données.
• Chiffre d'affaires : la remontée et la consultation de votre chiffre d'affaires, à comparer avec vos heures prestées et vos coûts.
• Exports : la récupération de vos données sous forme d'export, pratique pour alimenter un reporting ou un autre logiciel.

Les codes de secrétariat social sont par ailleurs alignés entre les shifts et les pointages, pour une remontée cohérente vers la paie.

Où trouver le détail

La documentation complète (chaque domaine, chaque champ) et un guide d'implémentation sont disponibles directement sur la plateforme Open API, à destination de vos équipes techniques ou de votre intégrateur. Cet article donne la vue d'ensemble ; la doc en ligne donne le mode d'emploi précis.

Ce que votre token peut réellement voir ou modifier dépend des permissions que vous lui avez accordées et du fait qu'il soit ou non en lecture seule. En cas de doute, vérifiez d'abord ses permissions.