Eduarte Connect
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 scholen: moderne koppelingen, grip op welke partij welke gegevens ontvangt (AVG), inzicht in het gebruik, en doorontwikkeling op basis van standaarden.
- Voor partners: een duidelijke overeenkomst en SLA, een eigen ontwikkelomgeving, support vanuit Eduarte, en zichtbaarheid richting scholen.
Voor wie & wat het oplevert
Connect bedient twee hoofddoelgroepen.
Scholen krijgen:
- AVG-inzage: inzicht in welke partner welke gegevens afneemt;
- regie via consent: koppelingen worden bewust toegestaan;
- inzicht in het daadwerkelijke gebruik van koppelingen;
- een “etalage” met beschikbare, standaard koppelingen.
Partners krijgen:
- een partnerovereenkomst en SLA;
- eenvoudige aansluiting en een eigen ontwikkelomgeving wanneer nodig;
- documentatie en developer-support;
- zichtbaarheid in de etalage richting scholen.
Soorten koppelingen
Binnen Connect onderscheiden we vier koppelvormen:
- Standaard partnerkoppelingen — domeinspecifieke koppelingen met bekende partners, doorgaans tweerichtings (lezen én schrijven), bijvoorbeeld BPV, Document Management en Examens.
- Generieke basisdata & ESB provisioning — basisgegevens (opleidingen, organisatie, deelnemers, verbintenissen, groepen, medewerkers) waarmee scholen hun eigen systemen voeden.
- Legacy webservices — de oudere webservices, die in de komende jaren rustig aan worden uitgefaseerd.
- 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:
- O — een onderwijsstandaard die sectorbreed geldt en op landelijk niveau wordt beheerd (OOAPI-gebaseerd, Engelstalig). De officiële specificatie wordt elders beheerd; deze documentatie beschrijft de koppeling zoals geïmplementeerd in Eduarte Connect en verwijst voor de volledige standaard naar de officiële bron.
- E — een Eduarte-specifieke koppeling, door Topicus Eduarte gedefinieerd voor het product Eduarte (Nederlandstalig, minder gestandaardiseerd maar specifieker). Dit is de hoofdmoot van Connect.
- I — interne koppelingen, uitsluitend voor Eduarte zelf; deze vallen buiten deze documentatie.
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:
- Aanvraag — een school of partner geeft aan welke koppeling(en) gewenst zijn.
- Afspraken — toegang wordt vastgelegd; voor partners via een overeenkomst en SLA, voor scholen via consent op de betreffende koppeling.
- Toegang & credentials — de aansluitende partij ontvangt OAuth2-clientgegevens en de bijbehorende scope(s).
- Ontwikkelen & testen — er is een ontwikkel-/testomgeving beschikbaar om de integratie te bouwen en te beproeven voordat deze in productie gaat.
- Support — vragen en meldingen lopen via Eduarte (connect@eduarte.nl).
Voor partners
Voor partners gelden enkele specifieke afspraken:
- Overeenkomst — er is een partnerovereenkomst met een SLA waarin beschikbaarheid, support en wederzijdse verantwoordelijkheden zijn vastgelegd. De partner betaalt per koppeling; de school wordt hiervoor niet belast.
- Beschikbaar stellen van een ontwikkelomgeving — Eduarte stelt waar nodig een developer-/testomgeving beschikbaar zodat de partner de koppeling kan bouwen en testen zonder productiegegevens.
- Support — partners krijgen documentatie en developer-support, en zijn zichtbaar in de etalage richting scholen.
Gemeenschappelijke principes
Alle Connect-koppelingen delen dezelfde technische uitgangspunten:
- REST & JSON als architectuur en formaat.
- Beveiliging via OAuth 2.0 (Client Credentials) over HTTPS, met scopes per koppeling.
- Vertrouwelijk alle data word alleen versleuteld verstuurd.
- Versionering volgens SemVer, met de major-versie in het pad.
- AVG & consent — gegevens worden alleen gedeeld waar dit is toegestaan, volgens het principe van dataminimalisatie.
De precieze invulling per koppeling staat in de bijbehorende technische specificatie.
Deze documentatie lezen
De Connect-documentatie bestaat per koppeling uit twee documenten:
- een productdocument (functioneel) — doel, domein, reikwijdte en functionele flows, bedoeld voor business- en projectrollen;
- een technische specificatie — beveiliging, conventies, foutafhandeling, throttling en beschikbaarheid, bedoeld voor developers.
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. |