Sinds WordPress versie 4.4 is het mogelijk om direct via een API te communiceren met jouw WordPress website. Dit biedt enorm veel mogelijkheden. Kort gezegd, je kunt een direct lijntje leggen met WordPress om berichten/ pagina’s uit te lezen maar ook weg te schrijven middels een API. Hiermee kun je externe applicaties koppelen aan WordPress die ook over een API beschikken en zo met elkaar laten praten. Naast WordPress kun de API ook gebruiken voor Woocommerce indien je ook een webwinkel hebt. Heb je hulp nodig neem dan contact met ons op.
In dit artikel zullen we leren hoe we de basis functionaliteiten van de WP REST API kunnen gebruiken, we zullen CRUD (Create, Read, Update en Delete) operaties uitvoeren met Postman HTTP request helper. Hoewel we Posts in de volgende voorbeelden gebruiken, zijn dezelfde concepten en werkstromen van toepassing op alle WP REST API-eindpunten. Ok laten we beginnen met het spelen met de API.
Berichten/ posts weergeven
Om de API-eindpunten toegankelijk te maken, moeten we onze permalink-structuur instellen in Instellingen / Permalinks / Algemene instellingen. Meestal heb je dit al gedaan als je een bestaande WordPress site wilt benaderen via de API. Zoals u in de video kunt zien, verzenden we een GET /wp-json/wp/v2/posts aanvraag en ontvangen we een JSON-antwoord van de API:
| [ | |
| { | |
| “id“: 1, | |
| … | |
| “link“: “http://wp-test.dev/hello-world/“, | |
| “title“: { | |
| “rendered“: “Hello world!“ | |
| }, | |
| … | |
| }, | |
| { | |
| “id“: 2, | |
| … | |
| }, | |
| … |
Een bericht aanmaken
Om een nieuw bericht van de API te maken, moeten we een geverifieerd verzoek doen, in dit artikel gebruiken we HTTP-basisverificatie, maar het is belangrijk op te merken dat deze methode alleen wordt gebruikt voor ontwikkelings- en testdoeleinden, in de productie moeten we veiligere verificatiemethoden gebruiken zoals OAuth1 of JSON Web Token.
Om Basic Authentication aan onze WordPress-site toe te voegen, moeten we Basic-Auth plugin installeren, in de bovenstaande video kloneer ik de plug-in van de repo, ook kun je de plug-in installeren en de .zip downloaden en installeren vanuit Plugins / Add Nieuwe / Upload-plugin.
Zodra de plug-in is geïnstalleerd en actief is, zijn we klaar om een nieuwe bericht te maken met behulp van basisverificatie. Laten we eens kijken hoe we dit in Postman kunnen doen.
Gebruik POST /wp-json/wp/v2/posts met de door u ingevoerde argumenten (bijv. titel van het bericht en inhoud) om een nieuw bericht te maken.
- Stel op het tabblad Autorisatie Type in als Basisverificatie
- Vul vervolgens de velden Gebruikersnaam en Wachtwoord in met de gebruikersnaam en het wachtwoord van WordPress.
- Klik op knop Verzoek bijwerken om de kopteksten van het verzoek in te vullen
- Schakel over naar tabblad Headers en u ziet het veld Autorisatie toegevoegd
- Schakel over naar het tabblad Body en voeg argumenten toe
- Klik ten slotte op de knop Verzenden
In de video voegen we alleen het titelargument toe, maar we kunnen meer argumenten toevoegen, we kunnen bijvoorbeeld een statusargument toevoegen met een publicatiewaarde om het bericht automatisch te publiceren wanneer het is gemaakt.
Een bericht (post) binnenhalen
Om een post op ID op te halen gebruikt u GET /wp-json/wp/v2/posts/id.
Een bericht (post) updaten
Om een bericht te updaten gebruikt u POST /wp-json/wp/v2/posts/id met argumenten.
Een bericht (post) verwijderen
Om een bericht te verwijderen, gebruikt u DELETE /wp-json/wp/v2/posts/id.
Zoals u kunt zien, is spelen met de API niet zo ingewikkeld. Zodra we onze verificatiemethode hebben ingesteld, is het doen van verzoeken aan de API eenvoudig met een HTTP-verzoekhelper zoals Postman.