U bent hier

API documentatie 2.0

Via het Open Data Portaal van de Tweede Kamer wordt data uit het parlementaire proces beschikbaar gesteld via 2 API's. De beschikbare data wordt weergegeven in het informatiemodel. Termen die gebruikt worden binnen deze data worden beschreven in het overzicht termen.

Toegang verkrijgen tot de API

Om het opbouwen van een Community te stimuleren en een goed functionerende verbinding te kunnen garanderen hebben we er in dit stadium voor gekozen om toegang te beperken.

Om toegang te krijgen tot de API doorloopt u de volgende stappen:

  1. Maak een account aan op dit portaal.
  2. Na het inloggen registreert u uw IP-adres(sen) waarmee u de API mee wilt benaderen op uw profiel pagina.
  3. Na gemiddeld 2 a 3 werkdagen ontvangt u een bevestingsbericht op uw e-mail adres. Voor de API's wordt u automatisch geauthenticeerd op basis van uw IP-adres. Hierna kunt u verbinden met de API.
Overzicht API end-points
End-point Adres Authenticatie methode
OData https://gegevensmagazijn.tweedekamer.nl/OData/v4/2.0/ Automatisch via IP-adres
SyncFeed https://gegevensmagazijn.tweedekamer.nl/SyncFeed/2.0/Feed Automatisch via IP-adres

Hoe u de verschillende end-points kunt gebruiken, leest u op de detail pagina's van de betreffende API (OData API 2.0 / SyncFeed API 2.0).

Let op: Momenteel is er nog geen maximum aan het aantal verzoeken via de API. Mogelijk wordt in de toekomst wel een maximum ingesteld, afhankelijk van het gebruik.

Welke API moet ik gebruiken?

Het Open Data Portaal kent 2 API’s: OData v4 en SyncFeed (Atom 1.0).

  • OData v4 gebruikt u om een snapshot van specifieke data in samenhang op te halen, bijv. alle informatie die te maken heeft met een specifieke Activiteit of Zaak. OData wordt in veelgebruikte applicaties zoals bijv. Excel en Microsoft Power BI standaard ondersteund als bron.
  • De SyncFeed gebruikt u wanneer u (een subset van) alle data uit de API wilt repliceren naar een eigen database en deze eigen database via een simpel mechanisme wilt synchroniseren.

[API] OData versie 4: snapshot van specifieke data in samenhang ophalen

Open Data Protocol (OData) versie 4 is een open protocol voor het ontwikkelen van REST (Representational state transfer) API’s. OData wordt in veelgebruikte applicaties zoals bijv. Excel en Microsoft Power BI standaard ondersteund als bron. Er is op het internet veel informatie beschikbaar voor ontwikkelaars hoe OData API’s bevraagd kunnen worden. Het OData protocol leent zich goed om een snapshot van verschillende entiteiten in samenhang op te kunnen halen met behulp van een enkele zoekvraag. Via de OData v4 API kan informatie opgevraagd worden in JSON formaat.

Uitgebreidere informatie en voorbeelden vindt u op de detailpagina OData API 2.0.

[API] SyncFeed (Atom 1.0): alle data repliceren naar eigen database

De SyncFeed welke is gebaseerd op de Atom 1.0 (XML) standaard heeft als doel om zo eenvoudig mogelijk (een subset van) alle data van het Open Data Portaal te synchroniseren met een eigen database. Dit stelt afnemers in staat om met behulp van eigen indexering en query strategieën de grote hoeveelheid informatie op een intuïtieve en efficiënte manier te raadplegen en te gebruiken. Doordat de SyncFeed iedere mutatie voorziet van een oplopend nummer is het mogelijk om alleen informatie op te vragen die recent is gewijzigd en zo een eigen database te synchroniseren. Via de SyncFeed kan informatie opgevraagd worden in XML formaat welke is voorzien van een XML Schema (XSD) .

Uitgebreidere informatie en voorbeelden vindt u op de detailpagina SyncFeed API 2.0.

Welke informatie kan ik opvragen?

In de openbare parlementaire data van de Tweede Kamer zijn diverse entiteiten aan elkaar gekoppeld. Het informatiemodel geeft deze koppelingen weer. Tevens is per entiteit een toelichting te vinden.

Overzicht termen

Dit overzicht maakt duiding en interpretatie van de data, zoals weergegeven in de API, mogelijk. Bekijk ook de algemene beschrijving van het werk van de Tweede Kamer.

Voor een juiste interpretatie van de data die via de API toegankelijk zijn, is een goed begrip van de betekenis daarvan essentieel. Bekijk de beschrijving van begrippen en entiteiten die in het werkproces en in de ICT-systemen van de Tweede Kamer voorkomen. Hieronder een concept versie van veelgebruikte termen in XML formaat: