PLOOI Aanlever-API

Deze pagina bevat informatie over de PLOOI aanlever-API voor het actief openbaar maken van documenten via PLOOI. U vindt hier technische specificaties en een functionele beschrijving.

Wat is een API?

API staat voor Application Programming Interface. Een API stelt verschillende softwaresystemen in staat om onderling gegevens uit te kunnen wisselen. Als een bepaald systeem gebruik maakt van een API, dan zorgt de API ervoor dat de functionaliteit van het betreffende systeem beschikbaar is voor andere systemen. Op die manier wordt de communicatie tussen verschillende systemen mogelijk gemaakt.

Technische specificaties

De technische specificaties van de PLOOI aanlever-API zijn terug te vinden in de OpenAPI-Specificatie. Hier zijn ook release notes beschikbaar.

Functionele beschrijving

Hier vindt u een functionele, niet-technische beschrijving van de PLOOI aanlever-API. Deze beschrijving is gebaseerd op de hierboven genoemde technische specificaties. De volgende onderwerpen worden besproken:

  • functionaliteit 
  • metadata
  • waardelijsten 
  • authenticatie
  • versieinformatie

Versie-informatie

Deze versie van de beschrijving van de functionaliteit van de aanlever-API PLOOI is gebaseerd op OpenAPI-Specificatie versie: v0.3.2-alpha, datum 16-6-2022. 

Let op: PLOOI en de aanlever-API zijn nog volop in ontwikkeling. De hier beschreven technische specificaties kunnen en zullen daarom waarschijnlijk nog veranderen. De laatste stand van zaken is terug te vinden in de OpenAPI-Specificatie van PLOOI. Let daarom altijd op het hierboven genoemde versienummer. Dit is de versie waar de beschrijving op gebaseerd is, maar er kan ondertussen een nieuwe versie gepubliceerd zijn. Bij verschillen geldt de informatie uit de OpenAPI-Specificatie.

Gebruik deze pagina niet als definitieve specificaties voor een leverancier. Aan de informatie op deze pagina kunnen geen rechten worden ontleend.

Vragen en opmerkingen

Heeft u na het lezen nog vragen? Of heeft u verbetertips voor ons? Mail dan naar plooi@koop.overheid.nl.