Documentation de l'API YA-Planning

Introduction

L'API est REST, en JSON, versionnée. Toutes les ressources métier vivent sous le préfixe /api/v1/pub/v1. Les endpoints de démonstration publics sont sous /api/v1/public/api-demo.

• Base URL : https://votre-domaine/api/v1/pub/v1
• Format : requêtes et réponses en application/json (sauf exports ICS/PDF).
• Versionnage : la version est dans le chemin (/v1) ; les ajouts rétrocompatibles ne changent pas la version.
• CORS : l'API publique est ouverte aux applications navigateur tierces (sans cookies).

Authentification

Chaque requête porte une clé API, dans l'un des deux en-têtes :

X-API-Key: yap_live_xxxxxxxxxxxxxxxxxxxx
# ou
Authorization: Bearer yap_live_xxxxxxxxxxxxxxxxxxxx

Une clé peut être autorisée pour plusieurs établissements (clé entreprise). Précisez alors la cible via l'en-tête X-Etablissement-Id ; s'il n'y a qu'un seul établissement autorisé, il est déduit automatiquement. Les clés sont créées, à scopes, dans la console.

Environnements & bac à sable

Deux environnements, distingués par le préfixe de la clé :

• yap_live_… — production : vos données réelles ; la génération décompte le quota hebdomadaire.
• yap_test_… — sandbox : les lectures renvoient un jeu de données de démonstration (jamais vos vraies données), la génération n'est pas décomptée, et l'écriture de configuration est refusée (SANDBOX_READONLY). Idéal pour développer sans risque.

Scopes

Chaque clé porte un sous-ensemble de scopes ; un endpoint refuse (403 INSUFFICIENT_SCOPE) si le scope requis manque.

Débit & quotas

Chaque clé a une limite de débit (par défaut 60 req/min). Les réponses portent :

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
X-RateLimit-Reset: 1783919311   # epoch (s) de réinitialisation

Un dépassement renvoie 429 RATE_LIMITED avec l'en-tête Retry-After. La génération d'emploi du temps est en plus soumise au quota hebdomadaire du forfait (visible via /me).

Toute réponse de l'API porte aussi un en-tête X-Request-Id (identifiant de corrélation) — communiquez-le au support en cas d'incident. Note : le comptage de débit est actuellement appliqué par instance ; sur un déploiement multi-instances la limite effective peut être un multiple de la valeur affichée.

Erreurs

Enveloppe d'erreur uniforme, avec un requestId pour le support :

{ "error": "INSUFFICIENT_SCOPE", "message": "Scope requis : config:write.",
  "requestId": "6181762d-…", "requiredScope": "config:write" }

Tester en direct — sans inscription

Endpoints de démonstration publics (aucune clé requise).

Postman : « Import » → « Link » → collez /q/openapi?format=json.

Référence — Compte & introspection

{
  "environment": "LIVE",
  "etablissementId": "61a9…8cb",
  "scopes": ["config:read", "timetables:write"],
  "entitlements": {
    "plan": "PRO",
    "generationsRestantes": -1,
    "resetLe": "2026-07-14T00:00:00Z",
    "maxClassesExport": -1
  }
}

{"id":"…","nom":"Groupe Scolaire Les Palmiers","slug":"gs-palmiers","sigle":"GSP","ville":"Abidjan","pays":"CI","type":"PRIVE","siteWeb":"https://…"}

{"apiKeyId":"…","days":30,"daily":[{"day":"2026-07-12","calls":128,"errors":3}]}

Référence — Compte — établissements

Provisioning niveau-compte : créez vos propres établissements SANS en-tête X-Etablissement-Id (le chemin /account n'est pas lié à un établissement). Scope establishments:manage. À la création, la clé appelante reçoit automatiquement un grant ACTIVE sur le nouvel établissement — utilisez ensuite X-Etablissement-Id pour le configurer et générer.

{"nom":"Groupe Scolaire Les Palmiers","type":"PRIVE_LAIC","pays":"CI"}

{"id":"…","nom":"Groupe Scolaire Les Palmiers","slug":"gs-les-palmiers","pays":"CI","type":"PRIVE_LAIC"}

[{"id":"…","nom":"…","slug":"…","pays":"CI","type":"PRIVE_LAIC"}]

Référence — Configuration

Structure pédagogique de l'établissement. Lecture : scope config:read. Écriture : scope config:write (interdite en sandbox). Un établissement fraîchement créé contient déjà un « Cycle principal ».

[{"id":"…","libelle":"Cycle principal","ordre":0}]

{"libelle":"Second cycle","ordre":1}

[{"id":"…","libelle":"6ème 1","cycleId":"…","effectif":42,"ordre":1}]

{"libelle":"6ème 3","cycleId":"<uuid-cycle>","effectif":40,"ordre":3}

[{"id":"…","libelle":"Mathématiques","code":"MATH","couleur":"#6C5CE7","ordre":1}]

{"libelle":"Physique-Chimie","code":"PC","couleur":"#00B894","ordre":5}

[{"id":"…","nom":"Koné","prenoms":"Awa","matricule":"P-0142","email":"…","telephone":"…","nombreHeureAutorise":18,"statut":"TITULAIRE","actif":true}]

{"nom":"Diarra","prenoms":"Sékou","matricule":"P-0210","email":"s.diarra@ecole.ci","nombreHeureAutorise":18,"statut":"VACATAIRE","actif":true}

[{"id":"…","jour":"MONDAY","heureDebut":"08:00","heureFin":"09:00","estPause":false,"libelle":null}]

{"jour":"MONDAY","heureDebut":"08:00","heureFin":"09:00","estPause":false,"libelle":"M1"}

[{"id":"…","cycleId":"…","disciplineId":"…","nombreHeuresObligatoire":4,"minHeuresConsecutives":1,"maxHeuresConsecutives":2}]

{"cycleId":"<uuid>","disciplineId":"<uuid>","nombreHeuresObligatoire":4,"minHeuresConsecutives":1,"maxHeuresConsecutives":2}

Référence — Emplois du temps

Génération asynchrone (le solveur tourne en tâche de fond — interrogez le statut), publication et consultation. En sandbox, la génération utilise un jeu de démonstration et n'est pas décomptée du quota.

{"durationMinutes": 5}

{"jobId":"…","status":"SOLVING_SCHEDULED"}

{"items":[{"jobId":"…","name":"…","status":"SOLVING_ENDED","workflowStatus":"BROUILLON","feasible":true,"hardScore":0,"softScore":-42,"createdAt":"…"}],"total":7,"page":0,"size":25}

{"jobId":"…","status":"SOLVING_ENDED","feasible":true,"lessons":[{"id":"1","matiere":"Maths","niveau":"6ème 1","professeur":"M. Koné","jour":"MONDAY","debut":"08:00:00","fin":"09:00:00","couleur":"#6C5CE7","niveauOrdre":1,"verrouille":false}]}

{"classes":["6ème 1","6ème 2","5ème 1"]}

Référence — Webhooks

Recevez des événements signés. Scope webhooks:manage. Le secret n'est renvoyé qu'à la création (ou après rotation). Événements : timetable.job.completed, timetable.job.failed, timetable.published, webhook.test. Chaque livraison est signée (HMAC-SHA256) et rejouée jusqu'à 5 fois en cas d'échec. L'URL est validée contre le SSRF (cibles internes/privées refusées).

{"url":"https://exemple.com/webhooks/yap","events":["timetable.published","timetable.job.completed"]}

{"endpoint":{"id":"…","url":"…","events":["timetable.published"],"active":true},"secret":"whsec_…"}

{"endpoint":{"id":"…","url":"…"},"secret":"whsec_…"}

Référence — Démo (public, sans clé)

Endpoints publics non authentifiés pour découvrir la forme des réponses.

Webhooks — vérifier une signature

Chaque livraison est un POST JSON avec les en-têtes X-Webhook-Event, X-Webhook-Timestamp et X-Webhook-Signature = HMAC-SHA256(timestamp + "." + body, secret). Vérifiez la signature et la fraîcheur du timestamp (moins de 5 min) pour éviter le rejeu. Événements : timetable.published, timetable.job.completed, timetable.job.failed, webhook.test.

POST https://votre-app/webhook
X-Webhook-Event: timetable.published
X-Webhook-Timestamp: 1712345678
X-Webhook-Signature: 9f86d081…

{ "event":"timetable.published", "jobId":"…", "etablissementId":"…", "occurredAt":"…" }

import crypto from "crypto";

// Express — vérifier la signature d'un webhook YA-Planning
app.post("/webhooks/yap", express.raw({ type: "*/*" }), (req, res) => {
  const ts  = req.header("X-Webhook-Timestamp");
  const sig = req.header("X-Webhook-Signature");
  const body = req.body.toString("utf8");

  const expected = crypto.createHmac("sha256", process.env.YAP_WEBHOOK_SECRET)
    .update(`${ts}.${body}`).digest("hex");

  // fraîcheur (anti-rejeu) : < 5 min
  const fresh = Math.abs(Date.now()/1000 - Number(ts)) < 300;
  if (!fresh || !crypto.timingSafeEqual(Buffer.from(sig), Buffer.from(expected)))
    return res.sendStatus(400);

  const event = JSON.parse(body); // { event, jobId, etablissementId, occurredAt }
  res.sendStatus(200);
});

Exemples de code

# Vérifier ses droits
curl https://votre-domaine/api/v1/pub/v1/me \
  -H "X-API-Key: yap_live_xxxxxxxxxxxx"

# Générer un EDT puis suivre le job
JOB=$(curl -s -X POST .../api/v1/pub/v1/timetables/generate \
  -H "X-API-Key: yap_live_xxxx" -H "Content-Type: application/json" \
  -d '{"durationMinutes":5}' | jq -r .jobId)

curl .../api/v1/pub/v1/timetables/jobs/$JOB \
  -H "X-API-Key: yap_live_xxxx"

Versions & dépréciation

L'API est versionnée dans le chemin (/api/v1/pub/v1/…). Nous ajoutons des champs et des endpoints de façon rétrocompatible ; ces ajouts ne constituent pas une rupture, alors codez de façon tolérante (ignorez les champs inconnus). Toute rupture donnera lieu à une nouvelle version majeure et à un préavis de 90 jours minimum, annoncé via l'en-tête de réponse Deprecation et le journal des modifications ci-dessous.