Accès API : planning, heures et absences

À quoi ça sert

L'option « accès API » permet à vos logiciels de comptabilité, de paie ou à votre CRM de lire automatiquement le planning publié de votre entreprise, les heures de chacun et les absences validées. L'accès est en lecture seule : rien ne peut être modifié par l'API.

L'option se prend dans l'application : Management → Gérer l'abonnement. Elle est ouverte pendant l'essai gratuit.

1. Créer une clé

Dans l'application, le propriétaire de l'entreprise ouvre Management → Accès API → Nouvelle clé, et lui donne un nom (par exemple « Logiciel de paie »). La clé complète n'est affichée qu'une seule fois : copiez-la dans votre logiciel. Vous pouvez la révoquer à tout moment ; 10 clés au plus par entreprise.

2. Appeler l'API

Envoyez la clé dans l'en-tête « Authorization: Bearer … » (ou « X-Api-Key »). Toutes les adresses commencent par https://app.staff-flow.cloud/api/v1/ext/.

curl -H "Authorization: Bearer sfk_xxxxxxxx_yyyyyyyy…" \
  "https://app.staff-flow.cloud/api/v1/ext/shifts?from=2026-10-01&to=2026-10-31"

3. Les adresses

GET /api/v1/ext/company     company, sites, positions
GET /api/v1/ext/members     people (current and former), role, dates
GET /api/v1/ext/shifts      published shifts         ?from=&to=&format=csv
GET /api/v1/ext/totals      published hours/person   ?from=&to=&format=csv
GET /api/v1/ext/absences    approved leave and unavailability  ?from=&to=

Période : « from » et « to » au format AAAA-MM-JJ. Sans « from », depuis la création de l'entreprise ; sans « to », jusqu'à aujourd'hui ; 5 ans au plus par appel.

Format : JSON par défaut ({"data": […]}) ; ajoutez « format=csv » pour un fichier CSV (séparateur « ; », lisible par Excel).

Seul le planning publié est transmis (ce que voient les salariés), jamais les brouillons.

4. Exemple de réponse

{
  "data": [
    {
      "id": "6c1f…", "day": "2026-10-06", "start": "08:00", "end": "16:00",
      "minutes": 480, "userId": "a41e…", "userName": "Olena",
      "siteId": "…", "site": "Centre", "positionId": "…", "position": "Barista",
      "note": null
    }
  ]
}

5. Erreurs

401 : clé absente, fausse ou révoquée. 402 : l'option « accès API » n'est pas active (abonnement sans l'option). 400 : dates invalides.

Données personnelles

L'entreprise reste responsable de l'usage des données qu'elle récupère (noms, horaires, absences) et doit les protéger dans ses propres logiciels. Gardez les clés secrètes ; révoquez une clé dès qu'elle ne sert plus.