Integratie

Publicatiedatum 27-02-2024, 13:47 | Laatste update 01-03-2024, 8:33 | Informatie

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:

• https://developer.wordpress.org/rest-api/
• https://developer.wordpress.org/rest-api/using-the-rest-api/
• https://developer.wordpress.org/rest-api/reference/

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.

Key	Value
id	Uniek ID van deze post.
date	Publicatiedatum van de post.
date_gmt	Publicatiedatum in GMT tijdzone.
modified	Datum laatste aanpassing.
modified_gmt	Datum laatste aanpassing in GMT.
title.rendered	Titel van de post.
content.rendered	De inhoud van de post in HTML.
meta	Metadata behorende bij de post.
wt_publication_category	ID’s van de categorieën waaronder deze post valt. (taxonomie)
wt_publication_tag	ID’s van de tags waaronder deze post valt. (taxonomie)
message_types	ID’s van de taxonomie “berichttype”. (taxonomie)

Pagina’s

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

Key	Value
id	Uniek ID van deze post.
date	Publicatiedatum van de post.
date_gmt	Publicatiedatum in GMT tijdzone.
modified	Datum laatste aanpassing.
modified_gmt	Datum laatste aanpassing in GMT.
title.rendered	Titel van de post.
content.rendered	De inhoud van de post in HTML.
meta	Metadata behorende bij de post.
tags	ID’s van de tags waaronder deze post valt. (taxonomie)
message_types	ID’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.

Key	Value
id	Uniek ID van deze post.
date	Publicatiedatum van de post.
date_gmt	Publicatiedatum in GMT tijdzone.
modified	Datum laatste aanpassing.
modified_gmt	Datum laatste aanpassing in GMT.
title.rendered	Titel van de post.
content.rendered	De inhoud van de post in HTML.
meta	Metadata behorende bij de post.
categories	ID’s van de categorieën waaronder deze post valt. (taxonomie)
tags	ID’s van de tags waaronder deze post valt. (taxonomie)
message_types	ID’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.

Key	Value
id	Uniek ID van deze term.
count	Het aantal berichten met deze term.
link	URL 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.