Une Introduction à l’API REST de WordPress

Quand l’API REST a finalement été ajoutée au noyau de WordPress, c’était la fin d’un long voyage. Beaucoup avaient anticipé ce changement comme le plus grand pas en avant pour WordPress dans l’histoire de la plateforme. Cependant, si tu n’es pas familier avec l’API REST, tu pourrais être confus quant à ce que tout cela signifie.

En résumé, l’ajout de l’API REST WordPress a transformé WordPress en un framework d’application complet. Cela a considérablement augmenté son « extensibilité », ou sa capacité à être étendu avec de nouvelles fonctionnalités et capacités. De plus, cela a élargi le potentiel de la plateforme pour communiquer avec d’autres sites et applications.

Une Introduction Aux REST APIs

Avant de nous plonger plus profondément dans l’API REST de WordPress, il est important de clarifier notre terminologie. C’est un sujet où nous devrons utiliser beaucoup d’acronymes, alors clarifions-les tout de suite.

Tout d’abord, tu dois savoir ce que sont les Interfaces de Programmation d’Applications (API). En termes simples, une API est un moyen par lequel un système permet à d’autres systèmes de se connecter à ses données.

Par exemple, lorsqu’un site web ajoute un bouton « J’aime » de Facebook à une page, il le fait en se connectant à l’API de Facebook. Cela permet à la page web d’utiliser l’API pour recevoir des données (le code du bouton J’aime) et envoyer des données (la demande de J’aime).

Alors, qu’est-ce qu’une API REST spécifiquement ? Representational State Transfer (REST) est un type d’API spécifique aux services web. Elle contient un ensemble standardisé d’instructions et de règles, facilitant ainsi la connexion entre tous les services « RESTful ».

En résumé, les API REST te permettent de faire des demandes à un système externe. Un exemple de cela est Twitter. Tu peux utiliser son API pour demander un certain nombre de tweets d’un utilisateur spécifique. L’API te retournera ensuite les tweets en fonction de ta demande, que tu peux intégrer sur ton site en utilisant HTML et CSS.

Ces demandes sont effectuées en utilisant la Notation des Objets JavaScript (JSON). Il s’agit d’un langage spécifiquement conçu pour l’envoi, la réception et le stockage de données.

Nous allons aborder JSON plus tard dans cet article, mais nous te recommandons de prendre le temps de te familiariser dès maintenant avec ce langage. Cela t’aidera à te préparer pour utiliser l’API REST de WordPress et à comprendre certains des concepts dont nous parlerons.

Ce Qu’Est L’API REST WordPress (Et Pourquoi C’Est Important)

La WordPress REST API fonctionne de manière très similaire aux exemples que nous avons déjà abordés. Fondamentalement, la WordPress REST API te donne un accès complet aux fonctionnalités de WordPress depuis n’importe quel framework compatible JSON.

De la même manière que l’API de Twitter vous permet de récupérer et d’envoyer des tweets, l’API REST de WordPress peut être utilisée pour gérer des articles, des utilisateurs, des catégories, et bien plus depuis des plateformes externes. Elle vous permet d’utiliser WordPress de plusieurs manières jusqu’alors inédites.

L’API REST a été annoncée dès 2013. Elle a commencé sa vie comme un plugin, destinée à être intégrée au noyau de WordPress dans la version 4.1. Comme cela arrive souvent, des retards ont repoussé la sortie jusqu’à ce qu’elle soit finalement mise en œuvre dans le noyau avec la sortie de WordPress 4.7 trois ans plus tard.

C’était une longue attente, mais cela en valait la peine pour de nombreuses personnes qui voyaient l’API REST de WordPress comme un pas important en avant pour la plateforme. Tu te demandes peut-être pourquoi cette addition était une si grande affaire, surtout que beaucoup d’utilisateurs n’ont probablement pas remarqué beaucoup de différence. En réalité, l’inclusion de l’API REST constituait un changement fondamental pour WordPress pour de nombreuses raisons.

En mettant en œuvre une API REST, WordPress s’est détaché de son statut de simple plateforme de création de sites web. Il est désormais devenu un framework d’application à part entière. Cela signifie que les développeurs peuvent utiliser un site WordPress pour créer des applications pour appareils mobiles et pour le web ou comme un dépôt d’informations.

Ce changement a également permis à WordPress de s’éloigner de sa dépendance au PHP. En rendant WordPress compatible avec tout langage compatible JSON, l’API REST a considérablement élargi les possibilités pour les développeurs, leur permettant d’utiliser les fonctionnalités de WordPress avec pratiquement n’importe quel framework.

Enfin, l’API REST offre une flexibilité accrue avec les interfaces que tu peux utiliser pour travailler avec la plateforme. Elle a rendu l’interface d’administration complètement optionnelle puisque tu peux maintenant interagir avec ton site WordPress entièrement via des commandes JSON.

Maintenant, regardons comment JSON et l’API REST se combinent pour rendre cela possible.

Comment L’API REST Et Le JSON Fonctionnent Ensemble

À présent, tu devrais maîtriser les aspects théoriques de l’API REST de WordPress. Alors, examinons le côté plus pratique de la technologie. Le manuel officiel décrit l’utilisation de l’API REST comme suit :

« L’API REST de WordPress fournit des points de terminaison d’API pour les types de données WordPress qui permettent aux développeurs d’interagir avec les sites à distance, en envoyant et recevant des objets JSON (JavaScript Object Notation). »

Le premier mot sur lequel nous devons nous concentrer ici est « endpoints ». La manière la plus simple de penser à un endpoint est comme une pièce de données ou une fonction qui peut être appelée en utilisant une requête JSON. Par défaut, WordPress propose un grand nombre de endpoints standards à utiliser, mais les développeurs peuvent également créer des endpoints personnalisés.

Pour atteindre un point de terminaison, tu dois utiliser une ‘route’, qui prend la forme d’une URL normale. Tu peux même essayer cela toi-même dès maintenant.

Rends-toi sur ton propre site WordPress, et ajoute /wp-json/wp/v2 à la fin de son URL. Si ton site est http://example.com, tu entrerais http://example.com/wp-json/wp/v2.

Lorsque tu charges cette route, tu atteindras le point de terminaison, qui dans ce cas, retourne tout le contenu et les métadonnées de ton site dans un format JSON (désordonné). En utilisant différentes routes, tu peux accéder à différents points de terminaison pour obtenir des types d’informations spécifiques et effectuer diverses tâches.

Il y a trois principales requêtes JSON que tu utiliseras avec l’API REST, alors jetons-y également un rapide coup d’œil maintenant. Elles sont :

• GET. Ce type de requête est utilisé pour récupérer et lister des données depuis l’API. Par exemple, tu utiliserais une requête GET pour retourner une liste d’utilisateurs sur ton site ou compiler des articles de blog sur une certaine période.
• POST. Cette requête est utilisée pour envoyer des données à l’API. Elle te permet de pousser de nouvelles informations vers WordPress, comme ajouter de nouveaux utilisateurs et articles ou mettre à jour des données existantes.
• DELETE. Comme son nom l’indique, cette requête est utilisée pour supprimer des données. Cela te permet de retirer des articles, pages, utilisateurs, et plus encore.

GET et POST peuvent parfois être utilisés avec le même point de terminaison pour obtenir des résultats différents.

Par exemple, examinons le point de terminaison /me/settings/. Si tu effectuais une requête GET sur ce point de terminaison, tu recevrais une liste des paramètres de l’utilisateur actuel. Cependant, en utilisant une requête POST sur le même point de terminaison, tu pourrais mettre à jour les paramètres à la place.

Commencer avec l’API REST de WordPress

Nous allons maintenant mettre toute cette théorie en pratique et te montrer quelques exemples très basiques de ce que tu peux faire avec l’API REST. C’est juste un aperçu pour t’aider à te familiariser avec l’utilisation de l’API REST pour traiter les requêtes vers WordPress.

Pour plus d’exemples, nous recommandons de consulter la bibliothèque de référence officielle et les Ressources API REST.

Les techniques suivantes nécessiteront que tu utilises la ligne de commande pour traiter les requêtes JSON. Cela te permet d’interagir avec ton site WordPress en utilisant une interface basée sur le texte et en envoyant des commandes simples.

Si tu n’as aucune expérience de l’utilisation de la ligne de commande, nous te recommandons de prendre un peu de temps pour apprendre les bases d’abord. Tu pourrais également vouloir utiliser SSH pour créer la connexion avec ton site.

Enfin, quand tu seras prêt, regardons quelques exemples de comment tu peux utiliser l’API REST de WordPress !

1. Renvoyer Les Publications D’un Site

Bien que tu aies évidemment besoin de l’autorisation appropriée pour modifier un site web, il est possible de récupérer certaines informations de presque n’importe quel site WordPress. Cela est dû au fait que l’API REST est uniforme sur toutes les installations WordPress.

Comme nous l’avons discuté, la raison principale de l’existence des APIs est de permettre aux applications externes d’accéder à certaines de tes données. Dans cet exemple, nous pouvons récupérer un seul article du blog officiel de nouvelles WordPress :

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

L’ID a été défini sur 1, ce qui signifie que cette requête va récupérer le tout premier article du blog. Il peut être difficile de voir car le JSON n’est pas très lisible, mais parmi le code, tu peux repérer tout le contenu et les métadonnées de l’article :

Tu pourrais alors utiliser ces informations dans une application, par exemple, pour les afficher avec ton propre style personnalisé.

Si tu souhaites récupérer tous les articles du blog, il te suffit de supprimer l’ID à la fin. Cependant, il est plus probable que tu veuilles récupérer un nombre sélectionné d’articles. La requête suivante retournera les trois derniers articles :

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

Tu peux essayer cela par toi-même avec d’autres sites, et même ton propre blog.

2. Mettre À Jour Un Article

Maintenant, essayons de faire quelques modifications à WordPress en utilisant l’API REST. Pour ce faire, tu dois être connecté au site que tu souhaites gérer. Par exemple, si tu utilises SSH, tu devras te connecter à ton serveur.

Dans cet exemple, nous allons mettre à jour un article existant. D’abord, utilisons une requête pour mettre à jour le titre de l’article avec l’ID de 1:

curl -X POST http://example.com/wp-json/wp/v2/posts/1 -d '{"title":"Un Nouveau Titre"}'

C’est assez explicite. L’argument du titre indique que tu mets à jour le titre du post, ce qui est suivi par la chaîne de texte contenant le remplacement.

Il existe de nombreux autres arguments que tu peux utiliser pour apporter des modifications à un article. Par exemple, tu peux utiliser une liste pour attribuer des catégories à l’article, le publier ou modifier entièrement son contenu.

3. Supprimer Un Utilisateur

Enfin, examinons comment tu peux supprimer des données en utilisant l’API REST. Dans cet exemple, nous allons supprimer un utilisateur du site. Naturellement, tu devras être connecté et autorisé à gérer les utilisateurs avant de pouvoir utiliser cette fonction.

Ensuite, tu peux utiliser la demande suivante pour supprimer l’utilisateur avec un ID de 101:

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

Cela supprimera l’utilisateur spécifié du site. Tu peux utiliser les paramètres supplémentaires pour réaffecter les articles de l’utilisateur à un autre utilisateur en fonction de son ID. Alternativement, tu peux forcer une suppression définitive au lieu d’ajouter l’utilisateur à la corbeille.

À travers ces exemples, tu peux commencer à voir comment l’API REST te permet de gérer le contenu de ton site et de te connecter aux autres. Si tu souhaites en savoir plus, nous te recommandons de te plonger davantage dans le Manuel de l’API REST.

Explore Le Développement WordPress

L’API REST WordPress a été un grand pas en avant pour la plateforme, la faisant sortir de ses racines pour aller vers le futur. Les développeurs étaient enthousiastes dès le premier jour, mais si tu n’étais pas familier avec les API REST pour commencer, tu as pu te demander pourquoi.

Bien que l’API REST puisse sembler complexe pour les débutants, tu n’as pas besoin d’être un développeur expérimenté pour utiliser certaines requêtes de base. Par exemple, l’API te permet d’effectuer diverses tâches sur ton propre site (ou d’autres), comme renvoyer des articles, mettre à jour des articles et supprimer des utilisateurs.

Cherches-tu un hébergement haute performance pour ton site WordPress ? Chez Dreamhost, nos plans gérés DreamPress offrent des environnements de préproduction professionnels, des sauvegardes automatiques, un cache intégré et plus encore. Découvre nos plans dès aujourd’hui !