Eduarte Connect — documentatie Overzicht
Vertrouwelijk — niet verspreiden
Algemene introductie

Eduarte Connect

Algemene introductie op de Eduarte Connect API-suite
versie 1.0 · 15 juni 2026

Wat is Eduarte Connect

Eduarte Connect is het platform waarmee scholen en hun partners op een moderne, veilige en AVG-proof manier koppelen met Eduarte. Connect vervangt stap voor stap de oudere webservices en de vrije databasetoegang door gestandaardiseerde REST-API’s met heldere afspraken over beveiliging, eigenaarschap van data en gebruik.

Het doel van Connect is drieledig:

Voor wie & wat het oplevert

Connect bedient twee hoofddoelgroepen.

Scholen krijgen:

Partners krijgen:

Soorten koppelingen

Binnen Connect onderscheiden we vier koppelvormen:

  1. Standaard partnerkoppelingen — domeinspecifieke koppelingen met bekende partners, doorgaans tweerichtings (lezen én schrijven), bijvoorbeeld BPV, Document Management en Examens.
  2. Generieke basisdata & ESB provisioning — basisgegevens (opleidingen, organisatie, deelnemers, verbintenissen, groepen, medewerkers) waarmee scholen hun eigen systemen voeden.
  3. Legacy webservices — de oudere webservices, die in de komende jaren rustig aan worden uitgefaseerd.
  4. Databasetoegang voor rapportage — directe gegevenstoegang uitsluitend ten behoeve van rapportage.

Naamgeving: O, E en I

De eerste letter van een connectorcode geeft het type aan:

Overzicht connectoren

Code Naam Domein Type Versie Sector Standaard
EKS Stamdata Stamdata E 1.0 Nee
EKB BPV-begeleiding BPV E 1.0 Nee
EKP Provisioning Provisioning E 1.0 Nee
EKN Notificaties Notifications E 1.0 Nee
EKOC Onderwijscatalogus Catalogus E 1.0 Nee
OKD Document Management DMS O 1.0 Ja
OKE Examens Examens O 1.0.1 Ja

Naast de connectoren kent Connect twee aanvullende categorieën: de Eduarte Legacy Webservices (in uitfasering) en de Eduarte Reporting service (gegevenstoegang voor rapportage).

Aansluiten op Connect

Aansluiten verloopt op hoofdlijnen als volgt:

  1. Aanvraag — een school of partner geeft aan welke koppeling(en) gewenst zijn.
  2. Afspraken — toegang wordt vastgelegd; voor partners via een overeenkomst en SLA, voor scholen via consent op de betreffende koppeling.
  3. Toegang & credentials — de aansluitende partij ontvangt OAuth2-clientgegevens en de bijbehorende scope(s).
  4. Ontwikkelen & testen — er is een ontwikkel-/testomgeving beschikbaar om de integratie te bouwen en te beproeven voordat deze in productie gaat.
  5. Support — vragen en meldingen lopen via Eduarte (connect@eduarte.nl).

Voor partners

Voor partners gelden enkele specifieke afspraken:

Gemeenschappelijke principes

Alle Connect-koppelingen delen dezelfde technische uitgangspunten:

De precieze invulling per koppeling staat in de bijbehorende technische specificatie.

Deze documentatie lezen

De Connect-documentatie bestaat per koppeling uit twee documenten:

De volledige, interactieve technische referentie (de gerenderde OpenAPI-specificaties) is de canonieke bron en staat op de documentatiesite. De PDF’s vatten samen en verwijzen daarheen voor de details per endpoint.

Begrippen & afkortingen

Afkortingen

Afkorting Toelichting
API Application Programming Interface
AVG Algemene Verordening Gegevensbescherming
ESB Enterprise Service Bus
HTTP Hypertext Transfer Protocol
HTTPS HTTP over TLS (versleutelde verbinding)
JSON JavaScript Object Notation
JWT JSON Web Token
OAuth2 Open Authorization 2.0 (autorisatieprotocol)
REST Representational State Transfer
SLA Service Level Agreement
TLS Transport Layer Security
URI Uniform Resource Identifier
URL Uniform Resource Locator

Begrippen

Begrip Toelichting
Authenticatie Het vaststellen van de identiteit van de aanroepende partij.
Autorisatie Het bepalen welke acties een geauthenticeerde partij mag uitvoeren (via scopes).
Bearer-token Beveiligingstoken dat de client meestuurt om zijn identiteit te bewijzen.
Connector Een afzonderlijke koppeling (API) binnen Eduarte Connect, bv. EKS of EKB.
Endpoint Een aanroepbare URI die HTTP-verzoeken accepteert.
Paginering Het in delen (pagina’s) ophalen van grote lijsten via offset en pageSize.
Resource Een aanspreekbaar object binnen de API, bv. een fase of een locatie.
Scope Een afgebakend toegangsrecht dat aan een token wordt gekoppeld (least privilege).
Stamdata Algemene referentiegegevens die door meerdere processen worden hergebruikt.
Statuscode HTTP-code waarmee de server het resultaat van een verzoek aangeeft (bv. 200, 404).
Token Tijdelijk uitgegeven bewijs van identiteit en rechten, gebruikt bij elke aanroep.