Een Introductie tot de WordPress REST API

Toen de REST API eindelijk toegevoegd werd aan de WordPress-kern, was het het einde van een lange reis. Velen hadden deze verandering verwacht als de grootste stap vooruit voor WordPress in de geschiedenis van het platform. Echter, als je niet bekend bent met de REST API, kun je verward zijn over wat het allemaal betekent.

Kort gezegd heeft de toevoeging van de WordPress REST API van WordPress een volledig uitgerust applicatieframework gemaakt. Dit heeft de ‘uitbreidbaarheid’ aanzienlijk vergroot, oftewel het vermogen om uitgebreid te worden met nieuwe functies en mogelijkheden. Bovendien heeft het de potentie van het platform om te communiceren met andere sites en applicaties uitgebreid.

Een Introductie Tot REST-API’s

Voordat we dieper ingaan op de WordPress REST API, is het belangrijk om onze terminologie recht te zetten. Dit is een onderwerp waarbij we veel acroniemen moeten gebruiken, dus laten we die eerst ophelderen.

Allereerst moet je weten wat Application Programming Interfaces (APIs) zijn. In de eenvoudigste termen is een API een manier waarop één systeem andere systemen in staat stelt om verbinding te maken met zijn gegevens.

Bijvoorbeeld, wanneer een website een Facebook ‘like’-knop aan een pagina toevoegt, doet het dit door in te haken op Facebooks API. Dit stelt de webpagina in staat om de API te gebruiken om gegevens te ontvangen (de code voor de like-knop) en gegevens te verzenden (het like-verzoek).

Dus, wat is een REST API specifiek? Representational State Transfer (REST) is een type API specifiek voor webservices. Het bevat een gestandaardiseerde set van instructies en regels, waardoor het makkelijker wordt voor alle ‘RESTful’ diensten om met elkaar te verbinden.

Kortom, REST APIs stellen je in staat om verzoeken te doen aan een extern systeem. Een voorbeeld hiervan is Twitter. Je kunt zijn API gebruiken om een bepaald aantal tweets te vragen van een specifieke gebruiker. De API zal dan de tweets retourneren op basis van je verzoek, die je op je site kunt integreren met behulp van HTML en CSS.

Deze verzoeken worden uitgevoerd met behulp van JavaScript Object Notation (JSON). Dit is een taal die specifiek is ontworpen voor het verzenden, ontvangen en opslaan van gegevens.

We gaan het later in dit artikel over JSON hebben, maar we raden je aan om je alvast vertrouwd te maken met deze taal. Dit zal je helpen om je voor te bereiden op het gebruik van de WordPress REST API en om enkele van de concepten waarover we zullen praten te begrijpen.

Wat De WordPress REST API Is (En Waarom Het Belangrijk Is)

De WordPress REST API functioneert grotendeels op dezelfde manier als de voorbeelden die we al hebben besproken. In principe geeft de WordPress REST API je volledige toegang tot WordPress-functies vanuit elk JSON-compatibel Framework.

Net zoals de API van Twitter je in staat stelt om tweets op te halen en te versturen, kan de WordPress REST API gebruikt worden om berichten, gebruikers, categorieën en veel meer te beheren vanaf externe platforms. Het stelt je in staat om WordPress op een aantal voorheen ongekende manieren te gebruiken.

De REST API werd aangekondigd al in 2013. Het begon als een plugin, bedoeld om te worden opgenomen in de WordPress core bij Versie 4.1. Zoals vaak gebeurt, zorgden vertragingen ervoor dat de release werd uitgesteld totdat het uiteindelijk in de core werd geïmplementeerd met de release van WordPress 4.7 drie jaar later.

Dit was een lange maar waardevolle wachttijd voor veel mensen die de WordPress REST API zagen als een belangrijke stap voorwaarts voor het platform. Je vraagt je misschien af waarom deze toevoeging zo’n grote zaak was, vooral omdat veel gebruikers waarschijnlijk niet veel verschil merkten. Zo blijkt, de opname van de REST API was een fundamentele verandering voor WordPress om vele redenen.

Door het implementeren van een REST API, heeft WordPress een stap gezet weg van alleen een platform voor het creëren van websites. In plaats daarvan is het nu een volwaardig applicatieframework geworden. Dit betekent dat ontwikkelaars een WordPress-site kunnen gebruiken om applicaties voor mobiele apparaten en het web te creëren, of als een informatieopslagplaats.

Deze verschuiving maakte het ook mogelijk voor WordPress om een stap te zetten weg van zijn afhankelijkheid van PHP. Door WordPress compatibel te maken met elke JSON-compatibele taal, heeft de REST API de mogelijkheden voor ontwikkelaars enorm uitgebreid, waardoor zij de functionaliteit van WordPress met vrijwel elk framework kunnen gebruiken.

Ten slotte biedt de REST API meer flexibiliteit met de interfaces die je kunt gebruiken om met het platform te werken. Het heeft de beheerinterface volledig optioneel gemaakt, aangezien je nu volledig via JSON-commando’s met je WordPress-site kunt interageren.

Laten we nu bekijken hoe JSON en de REST API samenkomen om dit mogelijk te maken.

Hoe De REST API En JSON Samenwerken

Tegen deze tijd zou je de theoretische aspecten van de WordPress REST API moeten begrijpen. Laten we dus eens kijken naar de meer praktische kant van de technologie. Het officiële handboek beschrijft het gebruik van de REST API als volgt:

“De WordPress REST API biedt API-eindpunten voor WordPress-datatypes waarmee ontwikkelaars op afstand kunnen interageren door JSON (JavaScript Object Notation)-objecten te verzenden en te ontvangen.”

Het eerste woord waar we ons op moeten richten is “endpoints”. De makkelijkste manier om een endpoint te zien, is als een stukje data of een functie die aangeroepen kan worden met een JSON-verzoek. Standaard voorziet WordPress in een groot aantal standaard endpoints om te gebruiken, maar ontwikkelaars kunnen ook aangepaste endpoints creëren.

Om een eindpunt te bereiken moet je een ‘route’ gebruiken, die de vorm heeft van een normale URL. Je kunt dit nu zelfs zelf proberen.

Ga naar je eigen WordPress-site en voeg /wp-json/wp/v2 toe aan het einde van de URL. Als je site http://example.com is, zou je http://example.com/wp-json/wp/v2 invoeren.

Wanneer je deze route laadt, bereik je het eindpunt, dat in dit geval alle inhoud en meta-gegevens voor jouw site retourneert in een (rommelig) JSON-formaat. Door verschillende routes te gebruiken, kun je toegang krijgen tot verschillende eindpunten om specifieke soorten informatie te verkrijgen en verschillende taken uit te voeren.

Er zijn drie primaire JSON-verzoeken die je zult gebruiken met de REST API, dus laten we er nu ook snel naar kijken. Ze zijn:

• GET. Dit type aanvraag wordt gebruikt voor het ophalen en weergeven van gegevens van de API. Bijvoorbeeld, je zou een GET-aanvraag gebruiken om een lijst van gebruikers op je site terug te krijgen of blogposts uit een bepaalde periode samen te stellen.
• POST. Deze aanvraag wordt gebruikt voor het verzenden van gegevens naar de API. Hiermee kun je nieuwe informatie naar WordPress sturen, zoals het toevoegen van nieuwe gebruikers en posts of het bijwerken van bestaande gegevens.
• DELETE. Zoals de naam al doet vermoeden, wordt deze aanvraag gebruikt om gegevens te verwijderen. Dit stelt je in staat om posts, pagina’s, gebruikers en meer te verwijderen.

GET en POST kunnen soms met hetzelfde eindpunt worden gebruikt om verschillende resultaten te bereiken.

Bijvoorbeeld, laten we eens kijken naar het endpoint /me/settings/. Als je een GET-verzoek op dit endpoint uitvoert, zou je een lijst van de huidige gebruikersinstellingen ontvangen. Echter, door het gebruik van een POST-verzoek op hetzelfde endpoint, zou je in plaats daarvan de instellingen kunnen bijwerken.

Aan de slag met de WordPress REST API

We gaan nu al deze theorie in praktijk brengen en je enkele zeer eenvoudige voorbeelden tonen van wat je kunt doen met de REST API. Dit is slechts een voorproefje om je vertrouwd te maken met het gebruik van de REST API voor het verwerken van verzoeken aan WordPress.

Voor meer voorbeelden raden we je aan om de officiële referentiebibliotheek en de REST API Resources te bekijken.

De volgende technieken vereisen dat je de opdrachtregel gebruikt om JSON-verzoeken te verwerken. Hiermee kun je interactie hebben met je WordPress-site door gebruik te maken van een tekstgebaseerde interface en eenvoudige commando’s te versturen.

Als je geen ervaring hebt met het gebruik van de opdrachtregel, raden we je aan om eerst de basis te leren. Je wilt misschien ook SSH gebruiken om de verbinding met je site te maken.

Eindelijk, als je er klaar voor bent, laten we eens kijken naar enkele voorbeelden van hoe je de WordPress REST API kunt gebruiken!

1. Berichten Terugkrijgen van een Site

Hoewel je uiteraard de juiste autorisatie nodig hebt om een website te bewerken, is het mogelijk om enige informatie van bijna elke WordPress-site op te halen. Dit komt omdat de REST API consistent is over alle WordPress-installaties.

Zoals we besproken hebben, bestaan API’s voornamelijk om externe applicaties toegang te geven tot een deel van je gegevens. In dit voorbeeld kunnen we een enkel bericht ophalen van de officiële WordPress nieuwsblog:

curl https://wordpress.org/news/wp-json/wp/v2/posts/1

Het ID is ingesteld op 1, wat betekent dat dit verzoek de allereerste post op de blog zal ophalen. Het kan moeilijk te zien zijn, aangezien de JSON niet erg leesbaar is, maar tussen de code kun je alle inhoud en meta-data voor de post vinden:

Je kunt deze informatie dan gebruiken in een applicatie, bijvoorbeeld om het weer te geven met je eigen aangepaste styling.

Als je in plaats daarvan elke post van de blog wilt terugzien, hoef je alleen maar de ID aan het eind te verwijderen. Het is echter waarschijnlijker dat je een select aantal posts wilt terugzien. Het volgende verzoek zal de laatste drie posts teruggeven:

curl https://wordpress.org/news/wp-json/wp/v2/posts/?per_page=3

Je kunt dit zelf proberen met andere sites en zelfs je eigen blog.

2. Werk Een Bericht Bij

Nu, laten we proberen enkele wijzigingen aan te brengen in WordPress met behulp van de REST API. Hiervoor moet je ingelogd zijn op de site die je wilt beheren. Bijvoorbeeld, als je SSH gebruikt, moet je inloggen op je server.

In dit voorbeeld zullen we een bestaande post bijwerken. Laten we eerst een verzoek gebruiken om de titel van de post met het ID van 1 bij te werken:

curl -X POST http://example.com/wp-json/wp/v2/posts/1 -d '{"title":"Een Gloednieuwe Titel"}'

Dit is vrij duidelijk. Het titelargument toont aan dat je de titel van het bericht bijwerkt, wat gevolgd wordt door de tekstreeks met de vervanging.

Er zijn veel andere argumenten die je kunt gebruiken om wijzigingen aan een bericht aan te brengen. Je kunt bijvoorbeeld een lijst gebruiken om categorieën aan het bericht toe te wijzen, het te publiceren, of de inhoud ervan volledig te veranderen.

3. Verwijder Een Gebruiker

Tenslotte kijken we hoe je gegevens kunt verwijderen met de REST API. In dit voorbeeld zullen we een gebruiker verwijderen van de site. Uiteraard moet je ingelogd en geautoriseerd zijn om gebruikers te beheren voordat je deze functie kunt gebruiken.

Daarna kun je het volgende verzoek gebruiken om de gebruiker met een ID van 101 te verwijderen:

curl -X DELETE http://example.com/wp-json/wp/v2/users/101

Dit zal de gespecificeerde gebruiker van de site verwijderen. Je kunt de extra parameters gebruiken om de berichten van de gebruiker toe te wijzen aan een andere gebruiker op basis van hun ID. Als alternatief kun je een permanente verwijdering forceren in plaats van de gebruiker naar de prullenbak te verplaatsen.

Aan de hand van deze voorbeelden kun je zien hoe de REST API je in staat stelt om de inhoud van je site te beheren en verbinding te maken met anderen. Als je meer wilt leren, raden we je aan om dieper in te gaan op de REST API-handboek.

Verken WordPress Ontwikkeling

De WordPress REST API was een enorme stap vooruit voor het platform, weg van zijn oorsprong en richting de toekomst. Ontwikkelaars waren vanaf dag één enthousiast, maar als je niet bekend was met REST API’s, kun je verward zijn geweest over waarom.

Hoewel de REST API overweldigend kan lijken voor beginners, hoef je geen ervaren ontwikkelaar te zijn om enkele basisverzoeken te gebruiken. Zo stelt de API je in staat om diverse taken uit te voeren op je eigen site (of anderen), zoals het teruggeven van berichten, het bijwerken van berichten en het verwijderen van gebruikers.

Zoek je naar hoogwaardige hosting voor je WordPress-site? Bij Dreamhost bieden onze DreamPress beheerde plannen professionele stagingomgevingen, automatische back-ups, ingebouwde caching en meer. Bekijk onze plannen vandaag nog!