API-documentatie

Een echte, werkende API voor integraties

ResultaatRegie heeft een live, met een API-sleutel beveiligde API voor read-only toegang tot je eigen examenseries en interventies. Genereer een sleutel via Instellingen → API-sleutels binnen je omgeving.

Kernentiteiten

Elke organisatie (schoolbestuur of school) werkt in een volledig gescheiden omgeving, afgeschermd via database-rijbeveiliging.

exam_series

Eén examenserie: vak, schooljaar, cohort, examentype (SE/CE), status (draft / actief / geanalyseerd).

wolf_domains

WOLF-domeinscores binnen een examenserie, met schoolscore, referentiescore en vorige score.

quality_analyses

Analyse-object met bewijs (evidence) en hypotheses, met een expliciet goedkeuringsveld (approved_by/approved_at).

interventions

Interventie met eigenaar, nulmeting, doelwaarde, huidige waarde, succesmetriek en evaluatiedatum.

intervention_events

Gebeurtenissen per interventie: reminder, check-in, evaluatie of besluit.

Beschikbare endpoints

GET/api/v1/exam-seriesAlle examenseries van je organisatie.
GET/api/v1/interventionsAlle interventies van je organisatie.

Voorbeeld

Elke aanroep vereist een Authorization: Bearer <API-sleutel>-header.

curl https://resultaatregie.elhoucineautomation.nl/api/v1/interventions \
  -H "Authorization: Bearer <API-sleutel>"

Response 200:
{
  "data": [
    {
      "id": "d290f1ee-...",
      "title": "Tweewekelijkse meetkunde-retrieval",
      "status": "proposed",
      "success_metric": "Domeinscore 54% naar 64%",
      "evaluate_on": "2026-10-08"
    }
  ]
}

Alleen lezen (GET), read-only. Meer schrijfendpoints volgen op basis van vraag.