Niet Stapelen Maar Vervangen - API

Op deze pagina vind je de API-beschrijvingen voor het aanbieden van educatief aanbod aan het Niet Stapelen Maar Vervangen ecosysteem. Met deze API-beschrijving kunnen aanbieders een endpoint opzetten dat uitgelezen wordt door Niet Stapelen Maar Vervangen.

De links op deze pagina leiden voorlopig naar een externe site: https://reference.exply.nl

Contracten

Uitwisseling Extern Aanbod

Versie 2.1.0  (oas 3.0.0) - 20250430

Wijzigingen ten opzichte van versie 2.0.0:

• In velden leerlingen_max_aantal, kosten_type, indicatie_tijdsduur en voorbereidingstijd keyword anyOf vervangen door keyword oneOf.
• Type van velden leerlingen_max_aantal, kosten_type, indicatie_tijdsduur en voorbereidingstijd gewijzigd van array naar string.
• Veld (string) periode_geldigheid laten vervallen, en de waarde gesplitst in twee nieuwe velden (date) beschikbaar_vanaf en (date) beschikbaar_tot, beide met formaat "dd-mm-yyyy".
• Format van het veld (date) vervaldatum_aanbod aangepast naar "dd-mm-yyyy".

Contract:

• Contract v2.1.0 met $refs
• Contract v2.1.0 met bundled $refs
• Documentatie bij contract v2.1.0

Versie 2.0.0  (oas 3.0.0)

Eerste versie

Contract:

• Contract v2.0.0 met $refs
• Contract v2.0.0 met bundled $refs

Referentielijsten

Versie 1.1 - 20250430

Wijzigingen ten opzichte van versie 1.0:

• In reflijsten kosten_type, leerlingen_max_aantal, indicatie_tijdsduur en voorbereidingstijd keyword anyOf (checkboxes) vervangen door oneOf (radios)
• Return type van reflijsten kosten_type, leerlingen_max_aantal, indicatie_tijdsduur en voorbereidingstijd gewijzigd van array naar string

Deelcontracten v1.1:

• classificatie_locatie_1
• classificatie_locatie_2
• doelgroep
• gebruik
• indicatie_tijdsduur
• kosten_type
• leergebied
• leerlingen_max_aantal
• licentievorm
• omvang_van_het_aanbod
• rol_leerkracht
• soort_activiteit
• soort_leermateriaal
• specifieke_doelgroep
• taal
• voorbereidingstijd

Versie 1.0

Eerste versie

Deelcontracten v1.0:

• classificatie_locatie_1
• classificatie_locatie_2
• doelgroep
• gebruik
• indicatie_tijdsduur
• kosten_type
• leergebied
• leerlingen_max_aantal
• licentievorm
• omvang_van_het_aanbod
• rol_leerkracht
• soort_activiteit
• soort_leermateriaal
• specifieke_doelgroep
• taal
• voorbereidingstijd
   

Tools

Wij gebruiken de volgende Free Open Source Software (FOSS) voor het ontwikkelen en testen van onze APIs:

Editor en documentatie

Als editor voor het schrijven van OpenApi-specificaties en het genereren van documentatie: swagger-editor.

Verificatie (linting) en bundling

Voor verificatie van OpenApi-contracten en het bundelen van externe $refs: Vacuum. Waarschuwing! Zonnebril benodigd!

Code-generatie

Voor het genereren van code op basis van OpenApi-specificaties: openapi-generator-cli. Zie ook de beschikbare server- en client-generators.

Mocking

Als mock server: Prism. Prism kan op basis van een OpenApi-specificatie heel snel een mock server opzetten. Dit is vooral handig om te testen of de OpenApi-specificatie de juiste server-API oplevert, en om clients te testen.