Documentação da API YA-Planning

Introdução

A API é REST, em JSON, versionada. Todos os recursos de negócio vivem sob o prefixo /api/v1/pub/v1. Os endpoints de demonstração públicos estão em /api/v1/public/api-demo.

• Base URL: https://o-seu-dominio/api/v1/pub/v1
• Formato: pedidos e respostas em application/json (exceto exportações ICS/PDF).
• Versionamento: a versão está no caminho (/v1); as adições retrocompatíveis não alteram a versão.
• CORS: a API pública está aberta a aplicações de navegador de terceiros (sem cookies).

Autenticação

Cada pedido leva uma chave API, num de dois cabeçalhos:

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

Uma chave pode estar autorizada para vários estabelecimentos (chave empresa). Indique então o destino através do cabeçalho X-Etablissement-Id; se só houver um estabelecimento autorizado, é deduzido automaticamente. As chaves são criadas, com âmbitos, na consola.

Ambientes e ambiente de testes

Dois ambientes, distinguidos pelo prefixo da chave:

• yap_live_… — produção: os seus dados reais; a geração desconta da quota semanal.
• yap_test_… — sandbox: as leituras devolvem um conjunto de dados de demonstração (nunca os seus dados reais), a geração não é descontada, e a escrita de configuração é recusada (SANDBOX_READONLY). Ideal para desenvolver sem risco.

Âmbitos

Cada chave leva um subconjunto de âmbitos; um endpoint recusa (403 INSUFFICIENT_SCOPE) se o âmbito requerido faltar.

Débito e quotas

Cada chave tem um limite de débito (60 req/min por defeito). As respostas levam:

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

Ultrapassá-lo devolve 429 RATE_LIMITED com o cabeçalho Retry-After. A geração de horários está além disso sujeita à quota semanal do plano (visível através de /me).

Toda a resposta da API leva também um cabeçalho X-Request-Id (identificador de correlação) — comunique-o ao suporte em caso de incidente. Nota: a contagem de débito é atualmente aplicada por instância; num destacamento multi-instância o limite efetivo pode ser um múltiplo do valor apresentado.

Erros

Envelope de erro uniforme, com um requestId para o suporte:

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

Testar em direto — sem registo

Endpoints de demonstração públicos (nenhuma chave necessária).

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

Referência — Conta e introspeção

{
  "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}]}

Referência — Conta — estabelecimentos

Aprovisionamento ao nível da conta: crie os seus próprios estabelecimentos SEM o cabeçalho X-Etablissement-Id (o caminho /account não está ligado a um estabelecimento). Âmbito establishments:manage. Na criação, a chave chamadora recebe automaticamente uma concessão ACTIVE sobre o novo estabelecimento — depois use X-Etablissement-Id para o configurar e gerar.

{"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"}]

Referência — Configuração

Estrutura pedagógica do estabelecimento. Leitura: âmbito config:read. Escrita: âmbito config:write (proibida em sandbox). Um estabelecimento recém-criado já contém um «Ciclo 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}

Referência — Horários

Geração assíncrona (o solver corre em segundo plano — consulte o estado), publicação e consulta. Em sandbox, a geração usa um conjunto de demonstração e não é descontada da 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"]}

Referência — Webhooks

Receba eventos assinados. Âmbito webhooks:manage. O segredo só é devolvido na criação (ou após rotação). Eventos: timetable.job.completed, timetable.job.failed, timetable.published, webhook.test. Cada entrega é assinada (HMAC-SHA256) e repetida até 5 vezes em caso de falha. O URL é validado contra o SSRF (destinos internos/privados recusados).

{"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_…"}

Referência — Demo (pública, sem chave)

Endpoints públicos não autenticados para descobrir a forma das respostas.

Webhooks — verificar uma assinatura

Cada entrega é um POST JSON com os cabeçalhos X-Webhook-Event, X-Webhook-Timestamp e X-Webhook-Signature = HMAC-SHA256(timestamp + "." + body, secret). Verifique a assinatura e a frescura do timestamp (menos de 5 min) para evitar a repetição. Eventos: 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);
});

Exemplos de código

# 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"

Versões e descontinuação

A API está versionada no caminho (/api/v1/pub/v1/…). Adicionamos campos e endpoints de forma retrocompatível; estas adições não constituem uma rutura, por isso programe de forma tolerante (ignore os campos desconhecidos). Toda a rutura dará lugar a uma nova versão maior e a um pré-aviso de 90 dias mínimo, anunciado através do cabeçalho de resposta Deprecation e do registo de alterações abaixo.