Tutoriel pour les débutants sur l’API Rest WordPress

Introduction

Presque tous les professionnels travaillant sur WordPress ont déjà entendu parler de l’API REST, grâce à son ajout principal à la fin de 2015. Cependant, pour la plupart, seuls les développeurs avancés ont pris le temps d’apprendre à quel point cette nouvelle fonctionnalité peut être puissante.

L’API REST WordPress regroupe de nombreuses fonctionnalités dans chaque mise à jour, en fournissant un API intégré qui peut être intégré dans les thèmes, les applications mobiles et plus encore. En d’autres termes, il permet aux développeurs de séparer l’interface frontale de la gestion des données, permettant à toute application d’interagir avec WordPress. Apprendre à travailler avec cet outil peut ouvrir des possibilités presque infinies pour étendre votre site WordPress.

Dans cet article, nous vous présenterons le projet WordPress REST API, nous expliquerons pourquoi il s’agit d’un gros problème, puis nous donner un aperçu de l’utilisation. Il n’y a plus de temps à perdre, alors commençons !

Présentation de l’API REST WordPress

Le projet d’API de transfert de statut représentatif de WordPress (REST) ​​affirme que WordPress fait des démarches pour devenir un cadre d’application à part entière. Son existence même prend en charge cette affirmation, car il ajoute une API REST classique dans le secteur, au noyau WordPress.

Le projet a d’abord été uploadé sur GitHub être développé en juin 2013 par Ryan McCue et Rachel Baker. Le plugin indépendant de l’API REST a été intégré au cœur de WordPress en décembre 2015, après avoir obtenu beaucoup de soutien public et attiré près de 100 collaborateurs pour améliorer ses capacités.

Depuis ses débuts sur le noyau WordPress, l’API REST s’est avérée avoir de nombreuses utilisations. Voici quelques façons dont vous pouvez en profiter dans vos projets, inspirés par des exemples tirés du monde réel :

1. Event Espresso utilise l’API REST pour fournir aux développeurs l’accès à leur infrastructure interne, permettant de développer des applications en fonction de leurs services.
2. Simmer permet aux développeurs d’accéder à l’API afin d’étendre leur fonctionnalité de recette à des applications mobiles à part entière ou à des thèmes personnalisés.
3. JoinIn alimente son propre widget « incorporable » à l’aide de l’API REST, en la remplissant avec les données appropriées partout où il est affiché.

Ce n’est que la partie visible de l’iceberg quand il s’agit d’utilisations innovantes pour l’API REST. Cependant, examinons maintenant comment fonctionne l’API REST.

Fonctionnement de l’API REST WordPress

Bref, l’API REST fonctionne en manipulant des données textuelles d’un endroit à l’autre sans accès direct à une base de données ou à une interface utilisateur. Il existe de nombreux types d’interfaces de programmation d’applications (API), bien que REST se distingue comme une norme moderne (anglais) .

Les API de REST sont livrées via les points d’extrémité du protocole de transfert de texte hypertexte (HTTP), en utilisant le formatage JSON (JavaScript Object Notation). En termes plus simples, ces technologies permettent d’accéder à l’API en utilisant des adresses web uniques pour fournir des données qui se comportent comme des objets JavaScript.

Si vous n’avez jamais travaillé avec JavaScript ou sa notation d’objet avant, il pourrait être une idée intelligente de commencer en apprenant les  bases de JSON. Une fois que vous êtes plus à l’aise avec le concept d’une API REST, parlons de l’impact majeur qu’il aura sur tous les développeurs WordPress.

Pourquoi l’API REST WordPress est-il important pour les développeurs ?

L’API REST WordPress est un connecteur universel de toute  installation WordPress à une application donnée sur un serveur web ou un système d’exploitation utilisateur. En fin de compte, cela signifie que la seule limite à ce qui peut être construit à l’aide de WordPress maintenant est notre imagination. Vous pouvez créer n’importe quelle application, coder avec n’importe quelle plate-forme ou langue, et utiliser WordPress pour gérer les données via l’API REST. Les implications de cela sont énormes, grâce à la communauté ouverte et amicale de WordPress.

En outre, comme l’API REST est basée sur JavaScript, cette focalisation croissante sur l’API marque un changement, dans lequel les langages de programmation sont les plus importants à apprendre. Vous pouvez bientôt trouver que le JavaScript côté serveur est le nouveau PHP. Cela peut déjà être vu dans le nouveau logiciel WordPress.com, Calypso, qui fonctionne complètement sur JavaScript et l’API REST.

En standardisant la façon dont les applications (y compris le cœur de WordPress) interagissent avec les données de WordPress, le développement de WordPress deviendra plus simple et plus intuitif. De plus, il deviendra plus facile d’intégrer des plates-formes tierces.

Cependant, la période de transition peut être un peu rude, c’est pourquoi il est important de commencer à apprendre à utiliser cette technologie maintenant. Il est temps de prendre les premières mesures pour utiliser l’API REST dans votre propre travail !

5 étapes pour démarrer avec l’API REST WordPress

Comme nous l’avons expliqué plus tôt, l’API REST peut être utilisé avec n’importe quelle application ou langage de programmation qui peut appeler un point d’extrémité HTTP (ce qui est la plupart d’entre eux). Par conséquent, nous nous concentrerons sur l’utilisation de la ligne de commande pour exécuter les requêtes de l’API REST, car c’est la méthode la plus simple et qui offre le moins de possibilités  pour des bugs programmatiques d’interrompre votre apprentissage.

Pour ce faire, vous voudrez ouvrir le programme de l’interface de ligne de commande (CLI) sur votre ordinateur – Terminal  sur MacOS et Linux et Invite de commandes dans Windows. La CLI vous permet d’interagir directement avec l’API REST, sans avoir besoin d’écrire des scripts supplémentaires pour demander et traiter les informations. Toute demande que vous faites dans la CLI peut être scriptée en PHP, JavaScript et d’autres langues, mais la méthode va varier pour chacune. Le fait de donner des commandes dans la CLI est direct. Tapez simplement la commande désirée et appuyez  sur ENTREE sur votre clavier.

Nous vous recommandons également de configurer un site de démonstration ou de tester localement, plutôt que de compléter ce tutoriel sur un site en direct. Enfin, la seule autre exigence est que votre site WordPress fonctionne avec la version 4.4 ou supérieure. Lorsque vous êtes prêts, commençons !

Étape 1 : Familiarisez-vous avec les concepts clés de l’API REST

Avant de commencer, c’est une bonne idée de vous familiariser avec toutes les parties mobiles de l’API REST. Il y a cinq concepts et termes clés que vous devez connaître. Examinons-les maintenant :

1. Les  « Routes » et  « Endpoints ». C’est l’aspect le plus important de l’API REST qu’il fautà comprendre. Les routeurs vous aident à parcourir les points d’extrémité, lorsqu’une méthode HTTP spécifique (par exemple un jeu de données statique ou une action) est connectée à un itinéraire spécifique. Par exemple,  /wp-json/ est une route configurée comme un point final, conçue pour nous montrer les itinéraires disponibles.
2. Les requêtes. Celles-ci sont créées en déclenchant les points d’extrémité corrects et en transférant des données.
3. Les réponses. En bref, cela fournit les données que vous avez demandées ou renvoie une erreur pour vous informer de ce qui a mal tourné.
4. Les schémas. Voici les réponses des modèles, donc vous savez toujours exactement où rechercher les bonnes données.
5. Les catégories de contrôleurs. En termes simples, ils vous permettent de construire vos propres itinéraires et points d’extrémité. Pour l’instant, vous n’avez pas à vous en préoccuper, même s’ils seront utiles par la suite.

Une fois que vous avez compris ces cinq concepts, vous pouvez commencer à approfondir l’API REST lui-même, en commençant par ses points d’extrémité.

Étape 2 : Apprenez à connaître les points d’extrémité les plus utiles de l’API REST

L’API REST WordPress offre un manuel de référence plein des points d’extrémité que vous trouverez les plus utiles. Tout d’abord, vous voudrez savoir comment construire un appel HTTP vers l’API REST. La base de chaque appel API WordPress REST est la suivante, en remplaçant l’espace réservé yourdomain.com par le vôtre :

http://yourdomain.com/wp-json/

Vous pouvez tester la connexion en exécutant la  commande Curl dans votre CLI en utilisant votre propre URL :

curl -X OPTIONS -i http://yourdomain.com/wp-json/

Vous devriez être accueilli avec un  message HTTP de succès. Vous pouvez ensuite répéter cette commande à l’aide de plusieurs des principaux points d’extrémité. Cette fois, nous utiliserons simplement la  version GET de curl.

Pour saisir une liste JSON de vos messages WordPress, vous pouvez utiliser les éléments suivants :

curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts

Alternativement, essayez ceci pour vérifier toutes vos pages existantes de WordPress :

curl -X GET -i http://yourdomain.com/wp-json/wp/v2/pages

Vous pouvez expérimenter chacun de ces points d’extrémité (et plus encore) dans la CLI pour examiner quel type de réponse est renvoyé pour chacun.

Étape 3 : Apprenez les bases de l’authentification de l’API REST

Maintenant, il est temps de se renseigner sur l’authentification. Certaines actions et données dans l’API REST sont publiques, tandis que d’autres exigent que vous soyez connecté en tant qu’administrateur. Cependant, il s’agit d’un API REST, donc il n’y a nulle part où vous connecter. Au lieu de cela, vous pouvez vous authentifier lors de tout appel nécessitant un accès administratif, tel que l’affichage de contenu non publié ou la mise à jour d’une publication.

Commencez par installer le plugin WordPress REST API Basic Auth. Il s’agit d’un simple plugin développeur uniquement pour vous aider à apprendre l’API REST rapidement et n’est pas destiné à des sites live. Cependant, le processus d’installation est comme n’importe quel autre plugin.

Une fois que Basic Auth est installé, vous pourrez vous authentifier sur la CLI avec le flag utilisateur. Voici un exemple de la façon d’appliquer la  méthode d’authentification utilisateur, en utilisant curl pour afficher les messages non publiés:

curl -X GET --user username:password -i http://yourdomain.com/wp-json/wp/v2/posts?status=draft

Une authentification sera requise pour tout autre chose que l’affichage d’informations publiques. Une fois que vous obtenez l’autonomie de base, vous pouvez explorer les autres options recommandées par la documentation de l’API REST pour votre code de production.

Étape 4 : Sélectionnez votre premier message WordPress avec l’API REST

Une fois que vous comprenez comment faire des appels de base à l’API REST à l’aide de curl, essayez de sélectionner une publication spécifique. Tout d’abord, écrivez tous vos messages comme précédemment :

curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts

Ensuite, trouvez l’ID d’une publication que vous souhaitez mettre à jour. Vous ajouterez cette ID à la fin de votre requête afin de sélectionner uniquement cette publication :

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

Vous pouvez utiliser cette option pour sélectionner une ID donnée pour un point final de l’API REST, que vous souhaitiez afficher une publication, une page ou une taxonomie.

Étape 5 : mettez à jour votre premier message WordPress avec l’API REST

Enfin, essayons d’envoyer une mise à jour à votre message sélectionné. Au lieu d’utiliser les  commandes OPTION ou GET, cette fois nous voulons POST un changement. GET permet de lire des données, tandis que POST est utilisé pour l’envoyer.

Reprenons le titre de votre poste à autre chose, en envoyant une  demande POST avec vos informations d’authentification. Les nouveaux changements seront partagés à l’aide du  flag d à la fin de votre commande. Vous passerez un objet JavaScript personnalisé en définissant la  variable de titre à une valeur personnalisée, comme  My New Title, comme indiqué dans le code d’exemple ci-dessous :

curl -X POST --user username:password http://yourdomain.com/wp-json/wp/v2/posts/<ID> -d '{"title":"My New Title"}'

Assurez-vous de remplacer le nom d’utilisateur, le mot de passe, l’ID du post et le nom du titre par vos propres informations. Vous pouvez sélectionner de nouveau la publication individuelle pour vérifier les nouvelles modifications :

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

Toutes nos félicitations ! Vous venez d’effectuer vos premières modifications administratives à l’aide de l’API REST WordPress. Bien sûr, ce didacticiel de base ne fait qu’explorer la surface de ce que l’API REST peut faire, mais à ce stade, il n’y plus de limites !

Conclusion

L’API REST de WordPress est un nouvel ajout puissant au noyau de WordPress, et peu de développeurs ont exploré toutes ses capacités. En conséquence, se lancer maintenant et apprendre à travailler avec lui peut vous rendre plus performant en tant que développeur et vous permettre de créer des applications à l’aide de WordPress comme cadre.

Pour examiner, voici nos cinq étapes pour apprendre à interagir avec l’API REST WordPress :

1. Familiarisez-vous avec les concepts clés de l’API REST.
2. Découvrez les points d’extrémité de l’API REST les plus utiles.
3. Apprenez les bases de l’authentification de l’API REST.
4. Sélectionnez votre première publication WordPress avec l’API REST.
5. Mettre à jour une publication WordPress avec l’API REST.

Quelles questions avez-vous concernant l’API REST WordPress ? Dites-nous tout savoir dans la section commentaires ci-dessous !