Comment débuter avec l’API Rest WordPress ?

Si vous travaillez régulièrement avec WordPress, vous avez très certainement déjà entendu parler de l’API REST ajouté en fin d’année 2015.

L’API REST WordPress regroupe beaucoup de fonctionnalités. Il fournit un API intégré que vous pouvez ajouter à vos thèmes et à vos applications par exemple. Cet API permet de séparer l’interface frontale de la gestion des données, ce qui permet à toutes applications de pouvoir interagir avec votre site WordPress. Travailler avec cet outil permet d’avoir des possibilités presque infinies sur WordPress.

Dans cet article, nous allons vous parler du projet API REST et nous vous donnerons un aperçu de son utilisation.

Qu’est ce que l’API REST WordPress ?

Le projet créé en juin 2013 a dans un premier été uploader sur GitHub. L’API REST, plugin indépendant a été intégré à WordPress en décembre 2015.

Depuis la mise en place de cet API dans le noyau de WordPress, ce dernier s’est avéré avoir de nombreuses utilisations. Certains projets utilisent l’API REST comme:

• Event Expresso: permet de fournir aux développeur l’accès à l’infrastructure afin de développer des applications en fonctions de leurs services
• Simmer: permet d’étendre les fonctionnalités
• JoinIn: Permet l’incorporation de Widget grâce à l’API REST

Ce n’est qu’une infime partie de ce qu’il est possible de faire avec l’API REST.

Comment fonctionne l’API REST WordPress ?

L’API REST permet de manipuler des données textuelles sans avoir un accès direct à la base de données ou à une interface utilisateur.

Les API REST sont livrées en utilisant le protocole HTTP et JSON (Javascript Object Notation). Grâce à cela, il vous est possible d’accéder à l’API en utilisant des adresses Web unique afin de fournir des données se comportant comme des objets JavaScript.

Cependant, il vous faudra un minimum de connaissance sur les bases de JSON avant de débuter.

Quel est l’importance de l’API REST WordPress pour les développeurs?

L’API REST WordPress est considéré comme un connecteur universel de toute installation WordPress à une application de donnée sur un serveur Web ou un système d’exploitation. Cela signifie aussi qu’il n’existe aucune limite lors de la confection de votre application, outre votre imagination. Il vous est possible de créer n’importe quel type d’application.

En standardisant la méthode dont les applications vont interagir avec WordPress, le développement de WordPress deviendra plus simple.

Débuter avec l’API REST WordPress en 5 étapes

Comme expliqué précédemment, il vous est possible d’utiliser l’API REST pour créer n’importe quelle application ou utiliser n’importe quel type de langage de programmation. En revanche, nous nous concentrons sur l’utilisation de la ligne de commande afin d’exécuter les requêtes de l’API.

Pour cela, il est nécessaire d’ouvrir le programme de ligne de commande (CLI) sur votre ordinateur. Le CLI vous permet d’interagir directement avec L’API REST. Afin de tester les possibilités de cet API, nous vous recommandons également de configurer un site de démonstration plutôt que de le faire sur un site en production. Le deuxième point important est qu’il faut que votre site Web soit au moins sous la version 4.4 de WordPress.

1 Se familiariser avec les clés de l’API REST

Avant de débuter avec l’API REST, il est nécessaire de se familiariser avec les parties mobiles de cet API. Il dispose de cinq concepts qu’il vous faut obligatoirement connaitre.

• Les “routes” et “EndPoints”: Les routes permettent de parcourir les points d’extrémité
• Les requêtes: Ces dernières sont créées en déclanchant les points d’extrémité
• Les réponses: Permet de vous communiquer les données ou les erreurs rencontrées
• Les schémas.
• Les catégories de contrôleurs: Permet de construire votre propre itinéraire et points d’extrémité.

Si vous avez compris ces cinq concepts, il vous est possible de débuter et approfondir l’API REST.

2. Apprendre à connaître les points d’extrémité les plus utiles de l’API REST

Un manuel de référence est disponible pour l’API REST. Vous y trouverez les points d’extrémités les plus utiles. Dans un premier temps, il vous faut savoir comment construire un appel HTTP vers l’API REST. La base est la suivante:

https://votredomaine.com/wp-json/

Il vous est possible de tester la connexion grâce à une commande Curl sur votre logiciel d’invite de commande:

curl -X OPTIONS -i https://votredomaine.com/wp-json/

Si tout a bien fonctionné, vous devriez avoir un message HTTP le signifiant. Il vous est possible de répéter cette commande à l’aide des points d’extrémité en utilisant la version GET:

Afin de saisir une liste JSON de vos messages WordPress, il vous est possible d’utiliser les éléments suivants:

curl -X GET -i https://votredomaine.com/wp-json/wp/v2/posts

Afin de vérifier les pages existantes de WordPress, vous pouvez utiliser la commande suivante:

curl -X GET -i https://votredomaine.com/wp-json/wp/v2/pages

Il vous est possible de tester chacun de ces points d’extrémités dans votre CLI.

3. Apprenez les bases de l’authentification de l’API REST

Il est maintenant temps d’apprécier le fonctionnement de l’authentification avec l’API REST. Certaines actions et données dans l’API REST sont publiques, cependant d’autres exigent que vous soyez connecté en tant qu’administrateur. S’agissant d’un API, il n’est pas possible de vous y connecter avec un identifiant et un mot de passe par le biais d’une page Web. Cependant, il vous est possible de le faire par le biais de ligne de commande lors de tout appel nécessitant un accès administrateur.

Pour cela, installez en premier lieu, le plugin Basic Auth de WordPress. Il s’agit d’un plugin dont le but est de vous apprendre à utiliser les fonctions de l’API REST.

Une fois cette extension installée, il vous sera possible de vous authentifier par ligne de commande. Vous trouverez ci-dessous un exemple sur la façon de s’authentifier:

curl -X GET --user utilisateur:motdepasse -i https://votredomaine.com/wp-json/wp/v2/posts?status=draft

Il vous sera obligatoirement demandé de vous authentifier pour tout ce qui n’est pas informations publiques.

4. Sélectionnez votre premier message WordPress avec l’API REST

Si vous avez compris le fonctionnement de base des appels de l’API REST à l’aide de la commande Curl, essayez de sélectionner une publication spécifique:

curl -X GET -i https://votredomaine.com/wp-json/wp/v2/posts

Trouvez l’ID de la publication que vous avez envie de mettre à jour. Ajoutez cette ID à la fin de votre requête afin d’explorer uniquement cette publication:

curl -X GET -i https://votredomaine.com/wp-json/wp/v2/posts/<ID>

5. Comment mettre à jour votre premier post avec l’API REST

Maintenant, vous allez pouvoir envoyer votre première mise à jour sur le post en question. A la place des commandes OPTION ou GET, nous allons utiliser POST. En effet, GET permet e lire les données et POST de les envoyer.

Nous allons donc envoyé par le biais de la commande CLI, une demande de modification du titre de notre post. Pour cela, il est nécessaire de s’authentifier.

curl -X POST --user utilisateur:motdepasse https://votredomaine.com/wp-jason/wp/v2/posts/<ID> -d '{"title":"Mon nouveau titre"}'

N’oubliez pas de changer “utilisateur” et “motdepasse” par vos informations de connexion mais aussi l’ID du post. Vérifiez que les informations ont bien été mise à jour avec la commande suivante:

curl -X GET -i https://votredomaine.com/wp-json/wp/v2/posts/<ID>

Conclusion

Félicitation, vous êtes arrivé jusqu’à la fin de cet article et vous savez désormais utiliser l’API REST WordPress.

L’API REST WordPress est un nouvel ajout très puissant peu exploré à ce jour par les développeurs Web. Débuter avec cet API vous permettra de créer de nouvelles applications et vous rendre plus performant en tant que développeur.