Ga direct naar inhoud

Woo-API

Let op: de Woo-API is nog niet in productie.
Tot nader bericht is het voor bestuursorganen nog niet
mogelijk om contactpersonen of gebruikersaccounts aan
te melden.

Introductie

Als overheidsorganisatie kunt u de API (Application Programming Interface) gebruiken om uw lokale systemen te koppelen aan de generieke Woo-voorziening voor het uitwisselen van informatie. Documenten en metadata die u in uw eigen systeem opslaat, worden via de API automatisch actief openbaar gemaakt op open.overheid.nl. Op deze pagina vindt u een beschrijving van hoe uw organisatie kan aansluiten op de API."

Voorbereiding

Voor aansluiting op de API moet vanuit uw eigen systeem een technische koppeling worden gerealiseerd. Neem hiervoor contact op met uw ICT-afdeling of externe leverancier(s). De voorbereidende activiteiten bij de bestuursorganen vallen onder de verantwoordelijkheid van de organisaties zelf. De informatie op deze pagina ondersteunt u bij de voorbereiding van de technische koppeling. Daarnaast zijn de volgende producten aanwezig ter voorbereiding:

Let op: Vooralsnog vragen we u alleen documenten te publiceren die openbaar gemaakt moeten worden na 1 april 2025. Het publiceren van documenten met terugwerkende kracht van voor deze datum vragen we u vooralsnog mee te wachten

Stappenplan API

Onderstaande stappen dienen te worden gevolgd:

Voorbereiding (STAP 1) Meld een contactpersoon aan voor uw bestuursorgaan en vraag als contactpersoon client credentials aan
(STAP 2) Ontvang de client credentials in uw e-mailbox
Testen (STAP 3) Test eerst de connectiviteit en zorg voor een eerste publicatie op de test-omgeving van KOOP alvorens u gaat publiceren op de productie-omgeving.
Publiceren op productie (STAP 4) Na een succesvolle test op de test-omgeving van KOOP kan uw organisatie starten met openbaar maken van documenten op de productie-omgeving

Toegang tot de API

Authenticatie

Authenticatie geschiedt via client credentials. Hoe dit in zijn werk gaat staat uitgelegd in de Functionele beschrijving AO Rijk API.

Aanmelden contactpersoon + aanvragen client credentials

Contactpersonen kunnen worden aangemeld door een tekenbevoegde vertegenwoordiger of een ander contactpersoon aan te melden.
Het onderstaande formulier dient ingevuld en ondertekend te worden opgestuurd naar woo@koop.overheid.nl.

Invulformulier Formulier I Woo API aanmelding en wijziging Contactpersoon

De credentials worden gestuurd naar het e-mail-adres van het opgegeven contactpersoon. U ontvangt client credentials voor zowel de productie-omgeving als de test-omgeving. Ook wordt de endpoint informatie hier in opgenomen.
 

Wat wordt verwacht van de contactpersoon?

Als contactpersoon bent u namens uw organisatie het aanspreekpunt voor KOOP en voor de gebruikers binnen uw organisatie. Het volgende wordt verwacht van een contactpersoon:

  • Binnen uw organisatie aanspreekpunt voor KOOP 
  • Het informeren van de eigen organisatie over wijzigingen rondom het aanleverloket en/of de API
  • Het aanvragen van client credentials ten behoeve van de API
  • De client credentials al dan niet te delen met uw externe leverancier.
  • Het communiceren van verstoringen of updates

Test-omgeving

De testomgeving is bedoeld voor ontwikkelaars die een technische koppeling met de API willen realiseren.
Dit betreft zowel ontwikkelaars van leveranciers die een dienst willen aanbieden, als ontwikkelaars van overheidsorganisaties die documenten actief openbaar moeten gaan maken. De testomgeving kan worden gebruikt voor voorbereidende technische tests.

Een set client-credentials voor deze omgeving wordt verstrekt samen met de credentials voor de productieomgeving.

Let op de volgende aandachtspunten en spelregels voor het gebruik van de testomgeving:

Aandachtspunten:

  • De testomgeving is geen ketentest-omgeving. 
  • De maximale bestandsgrootte is 1mb
  • De testomgeving is niet bedoeld om performancetesten of stresstesten te initiëren.

Fair use Policy

Er zijn geen kosten verbonden aan het gebruik. Bij (ogenschijnlijk) verkeerd gebruik of misbruik van de testomgeving zal KOOP contact opnemen met de betreffende organisatie en in het uiterste geval de toegang intrekken. KOOP neemt contact op als:

  • Er vermoeden is van onwettige activiteiten;
  • KOOP constateert dat de testomgeving structureel zo zwaar wordt belast dat andere gebruikers of KOOP daar substantiële hinder van ondervinden.

End-point informatie

De end-points van zowel de test-omgeving als productie-omgeving worden meegestuurd met de client-credentials.

Documentopslag

Documenten aangeleverd door kerndepartementen en Rijks-uitvoeringsorganisaties worden opgeslagen binnen de Generieke Woo-voorziening van Logius|KOOP.

Veelgestelde vragen

Alle veelgestelde vragen staan bij elkaar op één pagina veelgestelde vragen.

Vergroot afbeelding

Ondersteuning

Gebruik de zoekfunctie van de website om een antwoord op uw vraag te vinden. Al uw functionele en technische vragen over het aansluiten op de generieke Woo-voorziening kunt u stellen via woo@koop.overheid.nl. KOOP verzorgt ook diverse online informatiebijeenkomsten en invulsessies over de Woo-index en de technische aanlevermethoden. Kijk hiervoor op de bijeenkomsten pagina. 

Aanvraagformulieren