Developers
API-documentatie
Een voorbeeldoverzicht van hoe EduRegie via een REST-API en webhook-events te koppelen is aan rooster-, communicatie- en managementsystemen. Onderstaande endpoints zijn illustratief en bedoeld als documentatie-preview.
Authenticatie
Elk verzoek wordt geauthenticeerd met een API-sleutel per school, meegegeven als bearer-token.
curl https://api.eduregie.nl/v1/meldingen \ -H "Authorization: Bearer <API-KEY>"
Voorbeeld-endpoints
| Methode | Endpoint | Omschrijving |
|---|---|---|
| POST | /v1/meldingen | Nieuwe verzuim- of vervangingsmelding aanmaken. |
| GET | /v1/meldingen/:id | Status en tijdlijn van een specifieke melding ophalen. |
| GET | /v1/rooster/impact | Lessen die door een melding zijn geraakt, met vervangingsvoorstel. |
| POST | /v1/webhooks | Een webhook-endpoint registreren voor procesupdates. |
Webhook-events
EduRegie publiceert procesevents zodra een stap in de workflow is afgerond — te gebruiken om je eigen systemen automatisch te laten meebewegen.
Verzuim & herstel
- absence.reported
- absence.extended
- absence.recovered
Vervanging & rooster
- replacement.assigned
- lesson.cancelled
- lesson.relocated
Communicatie
- guardian.update.queued
- guardian.update.sent
Verlof
- leave.requested
- leave.approved
- leave.rejected
Deze documentatie is een voorbeeldweergave van de API-mogelijkheden. Bekijk technische specificaties of neem contact op voor toegang tot een sleutel.