Facebook Pixel
Fit'DistanceDocumentation
Ouvrir l'app
Sur cette page

Suivre automatiquement un groupe d'élèves

Pose un tag sur un groupe d'élèves, lis chaque matin leurs bilans en attente, écris le retour et passe le bilan à fait.

Un tag réunit les élèves que tu veux suivre de près. Chaque matin, ce cas pratique lit leurs bilans en attente, écrit un retour et marque le bilan comme fait. Il écrit en ton nom : il lui faut une clé avec Élèves › Lire et Écrire (students:read, students:write), Bilans › Lire et Écrire (bilans:read, bilans:write) et le périmètre sensible bilans.medical:read, qui permet de lire les commentaires d'un bilan. Il faut aussi une offre qui inclut les écritures. Crée la clé dans l'app, conditions d'usage acceptées.

Ce que fait ce cas pratique

  1. Créer le tag, une seule fois : POST /operations/students.tag_create avec {"name": "auto"}. La réponse donne l'uid du tag.
  2. Le poser sur les élèves suivis : POST /operations/students.tags_set avec {"studentId": 42, "tagUids": ["<uid>"], "mode": "add"}.
  3. Chaque matin : GET /bilans?status=PENDING&tag=<uid>, toutes les pages.
  4. Lire le bilan et son fil : GET /bilans/{id}, puis POST /operations/bilans.comments_list avec {"bilanId": 7}.
  5. Écrire le retour : POST /operations/bilans.comment_create avec dry_run: true d'abord, sans clé d'idempotence, puis la vraie écriture avec l'en-tête Idempotency-Key: retour-<bilanId>.
  6. Marquer le bilan fait : POST /operations/bilans.set_status avec {"bilanId": 7, "status": "DONE"}.
curl -X POST https://api.fitdistance.io/api/partner/v1/operations/bilans.comment_create \
  -H "Authorization: Bearer fd_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"bilanId": 7, "content": "Assistant (IA) de Léa Coach — …", "dry_run": true}'

Quand l'aperçu te convient, rejoue l'appel sans dry_run, avec l'en-tête Idempotency-Key: retour-7. Voir Écritures et idempotence.

Ce que ça coûte

Chaque appel coûte un crédit. L'aperçu avec dry_run: true est gratuit.

Ce qu'il faut savoir

  • Le retour est signé du nom du coach. Si une IA l'écrit, elle se présente elle-même dans le texte, par exemple « Assistant (IA) de Léa Coach — … ».
  • Une clé d'équipe (team:read) lit les bilans des formateurs, mais bilans.comment_create et bilans.set_status sur l'un d'eux répondent 404, comme tout bilan qui n'appartient pas au coach de la clé.
  • Un tag appartient au coach qui l'a créé.
  • bilans.comments_list demande le périmètre sensible bilans.medical:read.

Voir Périmètres pour le détail de chaque périmètre.

Page suivanteLe contrat OpenAPIOù lire le contrat OpenAPI de l'API, comment en générer un client avec une commande, et pourquoi la référence du site dit la même chose.