Ga direct naar de inhoud Ga direct naar de footer

Integratie

Ontwikkelaars kunnen via de WordPress REST API interface toegang krijgen tot de informatie op deze website. Op die manier is de informatie te integreren in uw eigen website of applicatie. Op deze pagina leest u welke informatie u kan ophalen via de REST API.

Over de REST API

De REST API van de Kennisgroepen-website is gebaseerd op de standaard REST API van WordPress. Meer informatie is te vinden op de onderstaande URL's:

Deze pagina beschrijft voornamelijk de uitzonderingen ten opzichte van de standaard REST API. Standaard verwijdert de Belastingdienst informatie over de auteur van content. Op verschillende plaatsen ontbreekt dus de waarde 'author'.

Data ophalen

Publicaties

URL: https://kennisgroepen.belastingdienst.nl/wp-json/wp/v2/wt_publication/
Response: Een array met objecten van het type "post". Elk object bevat onder andere de volgende waarden.

KeyValue
idUniek ID van deze post.
date Publicatiedatum van de post.
date_gmtPublicatiedatum in GMT tijdzone.
modified Datum laatste aanpassing.
modified_gmtDatum laatste aanpassing in GMT.
title.renderedTitel van de post.
content.renderedDe inhoud van de post in HTML.
metaMetadata behorende bij de post.
wt_publication_categoryID's van de categorieën waaronder deze post valt. (taxonomie)
wt_publication_tagID's van de tags waaronder deze post valt. (taxonomie)
message_typesID's van de taxonomie "berichttype". (taxonomie)
Let op!  Koppeling publicatie aan kennisgroep

Op de site van kennisgroepen wordt de taxonomie "wt_publication_tag" gebruikt om een publicatie aan een kennisgroep te koppelen. De waarde van dit veld zal dus een taxonomie-term zijn die correspondeert met de kennisgroep waar de publicatie onder valt.

Pagina's

URL: https://kennisgroepen.belastingdienst.nl/wp-json/wp/v2/pages

KeyValue
idUniek ID van deze post.
date Publicatiedatum van de post.
date_gmtPublicatiedatum in GMT tijdzone.
modified Datum laatste aanpassing.
modified_gmtDatum laatste aanpassing in GMT.
title.renderedTitel van de post.
content.renderedDe inhoud van de post in HTML.
metaMetadata behorende bij de post.
tagsID's van de tags waaronder deze post valt. (taxonomie)
message_typesID's van de taxonomie "berichttype" (optioneel). (taxonomie)

Nieuwsberichten

URL: https://kennisgroepen.belastingdienst.nl/wp-json/wp/v2/posts
Response: Een array met objecten van het type "post". Elk object bevat onder andere de volgende waarden.

KeyValue
idUniek ID van deze post.
date Publicatiedatum van de post.
date_gmtPublicatiedatum in GMT tijdzone.
modified Datum laatste aanpassing.
modified_gmtDatum laatste aanpassing in GMT.
title.renderedTitel van de post.
content.renderedDe inhoud van de post in HTML.
metaMetadata behorende bij de post.
categoriesID's van de categorieën waaronder deze post valt. (taxonomie)
tagsID's van de tags waaronder deze post valt. (taxonomie)
message_typesID's van de taxonomie "berichttype" (optioneel). (taxonomie)

Paginering

Voor opties met betrekking to paginering zie: https://developer.wordpress.org/rest-api/using-the-rest-api/pagination/

Een enkele post ophalen

URL: https://kennisgroepen.belastingdienst.nl/wp-json/wp/v2/[posttype]/[id]

Om de publicatie met ID 12 op te halen:
URL: https://kennisgroepen.belastingdienst.nl/wp-json/wp/v2/wt_publication/12

Voor het nieuwsbericht met ID 56:
URL: https://kennisgroepen.belastingdienst.nl/wp-json/wp/v2/post/56

Linking en embedding

Het is mogelijk om extra informatie toe te voegen aan de response door middel van de URLparameter '_embed'.
https://developer.wordpress.org/rest-api/using-the-rest-api/linking-and-embedding/
Voorbeeld:
URL: https://kennisgroepen.belastingdienst.nl/wp-json/wp/v2/wt_publication/12?_embed
De response bevat nu een waarde '_embedded', met daarin onder andere de aan de post
gekoppelde taxonomie-termen.

Taxonomieën

Om meer informatie op te halen over een taxonomie of term die gekoppeld is aan een post, kunnen extra calls gedaan te worden, op basis van de naam van de taxonomie of het ID van de term.

URL: https://kennisgroepen.belastingdienst.nl/wp-json/wp/v2/[taxonomie]

Response: Een array met objecten van het type "term". Elk van deze objecten bevat onder andere de volgende waarden.

KeyValue
idUniek ID van deze term.
countHet aantal berichten met deze term.
linkURL van de overzichtspagina van deze term.
name De naam van de term.

Een enkele term ophalen

URL: https://kennisgroepen.belastingdienst.nl/wp-json/wp/v2/[taxonomie]/[id]

Om meer informatie over de categorie met id 34 op te vragen:
URL: https://kennisgroepen.belastingdienst.nl/wp-json/wp/v2/categories/34

Onderhoud en wijzigingen

Onderhoud en wijzigingen op de website en de API-koppeling gebeurt tijdens kantoortijden. Dit geldt ook voor het oplossen van incidenten.

Ter informatie!  Vraag of opmerking over deze pagina of werkt er iets niet?

Neem dan contact op met het ontwikkelteam door een e-mail te sturen.

Deel deze pagina