PLOOI-Sandbox

Dit is de startpagina voor ontwikkelaars die aan de slag gaan met de PLOOI-Sandbox. Hier leggen we uit wat de PLOOI-Sandbox is en hoe u er gebruik van kunt maken.

Wat is de PLOOI-Sandbox?

De PLOOI-Sandbox is een omgeving voor ontwikkelaars die een systeemkoppeling bouwen met PLOOI die gebruik maakt van de aanlever-API. Het gaat om ontwikkelaars van leveranciers die een dienst willen aanbieden en ontwikkelaars van overheidsorganisaties die documenten actief openbaar moeten gaan maken. De ontwikkelaars kunnen deze omgeving gebruiken voor voorbereidende technische testen. 

De PLOOI-Sandbox is gebaseerd op de PLOOI aanlever-API. De PLOOI-Sandbox bestaat uit een API URL Path en een Postman-collectie met testbestanden. 

De PLOOI-Sandbox werkt met een ‘stub’ en bevat een gedeelte van de functionaliteit voor het aanleveren aan PLOOI. Ontwikkelaars kunnen een request sturen naar de PLOOI-Sandbox en krijgen dan op basis van de inhoud van dat request een response. De response lijkt zoveel mogelijk op het antwoord dat in de uiteindelijke productieversie verwacht kan worden. De aangeleverde metadata en documenten worden, na verzending aan de Sandbox-omgeving, niet verwerkt en zijn niet in te zien. Er is geen Sandbox-versie van het PLOOI-portaal beschikbaar.

De PLOOI-Sandbox is geen ketentest-omgeving. De opgestuurde gegevens worden niet verwerkt en zijn niet op te zoeken in een testversie van Overheid.nl | Overheidsdocumenten. Gegevens die via een request aan de PLOOI-Sandbox worden gestuurd, worden dagelijks geschoond en worden niet langer dan 24 uur bewaard. 

Waar vind ik de technische specificaties van de PLOOI aanlever-API?

De technische specificaties van de PLOOI aanlever-API worden beschreven in een OpenAPI Specificatie.

De versie van de PLOOI aanlever-API op de Sandbox-omgeving is gelijk aan de laatste versie van de OpenAPI Specificatie.

Waar vind ik de PLOOI-Sandbox?

De API URL Path van de PLOOI-Sandbox-API is https://open-sdb.overheid.nl/overheid/openbaarmaken/api/v0/metadata.

Postman Collectie

Download onderstaand onze Postman Collectie en test direct op onze Sandbox omgeving. De berichten kunnen worden getest met behulp van de applicatie Postman (download postman / postman introductie). Postman is een tool voor (onder andere) het testen van RESTful API’s. De collectie bevat diverse testbestanden en testscenario's. Het is mogelijk om eigen bestanden in te sturen als test of om metadata in testbestanden aan te passen. Deze kunt u downloaden en installeren op uw eigen computer. Door vervolgens de Sandbox-Postman-Collectie te importeren kunt u aan de slag!

Hoe kan ik gebruik maken van de PLOOI-Sandbox?

Wat zijn de kosten?

De Sandbox-omgeving is publiek toegankelijk. Er zijn geen kosten verbonden aan het gebruik. 

Hoe kan ik me aanmelden als gebruiker?

Voor het gebruik van de Sandbox-omgeving is een token nodig. Deze kan worden aangevraagd door het invullen van het aanvraagformulier. Hiermee accepteert u de fair use Policy. Ons team bekijkt de aanvraag en stuurt een token en bevestiging terug of stelt aanvullende vragen. Uitgegeven tokens zijn geldig tot 1 juni 2023.

De token moet toegevoegd worden als header met key: Aanlever-Token value: <verkregen token>.

In de huidige versie van de Sandbox wordt gebruik gemaakt van een token. De productie-versie van de PLOOI aanlever-API zal gebruik gaan maken van Centraal Aansluitpunt en Digikoppeling. Deze kunnen dus niet hier worden getest. De PLOOI-Sandbox is daarom ook geen noodzakelijke en/of formele stap in het aansluitproces. 

Fair Use Policy

De Sandbox-omgeving is publiek toegankelijk. Er zijn geen kosten verbonden aan het gebruik. Bij verkeerd gebruik of misbruik van de Sandbox kunnen we contact zoeken en in het uiterste geval de toegangstoken intrekken. Wij zoeken contact als wij:

  • vermoeden dat sprake is van onwettige activiteiten
  • constateren dat u structureel de Sandbox zo zwaar belast dat andere gebruikers daar substantiële hinder van ondervinden

Support en Feedback

De PLOOI aanlever-API is nog volop in ontwikkeling. Wij horen daarom heel graag over uw ervaringen met de Sandbox en tips voor verbeteringen. Voor feedback, verdere vragen en eventuele problemen kunt u contact met ons opnemen via plooi@koop.overheid.nl.

Support op de PLOOI-Sandbox is op basis van best effort. Er kunnen geen rechten ontleend worden aan het gebruik van de PLOOI-Sandbox.