Qu'est-ce que l'API WordPress REST et comment l'utilisez-vous ?

Vous avez probablement entendu parler de l'API REST. Peut-être avez-vous entendu dire que les utilisateurs de WordPress en bénéficient. Mais vous vous demandez peut-être aussi ce qu'est exactement une API WordPress.

Comprendre le fonctionnement des API n'est pas aussi compliqué qu'il n'y paraît. Continuez à lire pour savoir ce qu'est une API, ce qu'est l'API REST et comment vous pouvez utiliser l'API WordPress REST dans vos sites.

Qu'est-ce qu'une API ?

Une interface de programme d'application (API) est un moyen pour deux applications de « parler » entre elles. Un système fait une demande et l'autre la satisfait. Les demandes qu'un système accepte doivent être incluses dans l'API, sinon la demande ne peut pas être satisfaite.

Pensez-y de cette façon. Peut-être que vous avez vraiment faim alors vous allez à Waffle House. Vous commandez du café, des œufs et des pancakes. La serveuse commence à écrire votre commande - puis devient confuse lorsque vous arrivez aux crêpes. Waffle House ne sert pas de crêpes. Ils ne servent que des gaufres.

Un système demandant des crêpes à partir d'un menu API qui ne sert que des gaufres va rester sur sa faim.

Qu'est-ce que l'API REST ?

Quand on dit API REST, on parle d'un système de contraintes conçu pour internet. Il décrit comment un site Web peut demander des informations à un autre site Web de manière évolutive et uniforme. REST signifie Representational State Transfer, qui a été défini par Roy Fielding dans sa thèse de doctorat.

Qu'est-ce que l'API REST de WordPress ?

L'API REST WordPress fait référence aux demandes adressées à un site Web fonctionnant sur WordPress. Si nous demandons une liste de publications ou de pages, nous pouvons nous attendre à recevoir ces informations de l'API WordPress REST. WordPress ne fournira jamais d'informations non rendues publiques, telles que des brouillons d'articles ou (plus important encore) des mots de passe d'utilisateur.

Ceci est fondamental pour l'éditeur de blocs, qui échange dynamiquement des données avec WordPress sans recharger la page. Chaque point de terminaison renvoie des données dans un format JSON lisible par JavaScript — ou dans ce cas des blocs.

Notez que l'API REST n'est qu'une des API fournies par WordPress. Il y a aussi, par exemple, l'API Database et l'API Metadata, qui sont utilisées par les plugins pour interagir avec WordPress sur le serveur. Vous pouvez en savoir plus sur les API WordPress dans le Codex.

Comment fonctionne une demande d'API WordPress REST ?

Il existe quelques parties de base de l'API REST, à savoir : les routes, les points de terminaison, les demandes et les réponses.

Itinéraires

Une route est la façon dont nous référençons l'URL par laquelle le site Web communique. Un itinéraire courant dans WordPress est « /wp-admin ». Bien qu'il ne s'agisse pas d'un itinéraire de l'API REST, il s'agit d'un itinéraire utilisé par le navigateur pour accéder au tableau de bord d'administration WordPress. Pour nos besoins, les routes de l'API REST commencent par "/wp-json" (JSON étant le format standard des données).

Points finaux

Un point de terminaison est la combinaison d'une route et du type de demande entrante. Une seule route peut se connecter à plusieurs points de terminaison, car il existe plusieurs types de requêtes. Les types de requêtes courants incluent GET (comment nous lisons les données sur une route) et POST (comment nous mettons à jour les données sur une route).

Demandes et réponses

Chaque communication avec l'API REST est prise en sandwich entre une requête et une réponse. Un système fait une requête à laquelle l'autre système répond. L'API REST WordPress inclut des objets pratiques permettant aux plugins d'accéder aux données de la demande (WP_REST_Request) et de gérer les données de réponse (WP_REST_Response) lors de l'extension de l'API REST WordPress.

Comment installer l'API REST dans WordPress

À partir de la version 4.7 de WordPress, WordPress inclut l'API REST en tant que fonctionnalité principale.

Si vous utilisez une version plus ancienne, vous pouvez installer le plugin de fonctionnalité json-rest-api. Cela a été utilisé pour développer l'API REST avant d'être entièrement intégré à la base de code WordPress. Ce plugin est techniquement fermé, il est donc recommandé de mettre à jour votre version de WordPress à la place (ou peut-être envisager l'hébergement WordPress géré et vous serez toujours à jour.)

Exemples d'API REST WordPress

Jetez un œil au site Web de GiveWP. Si vous allez sur leur blog, vous pourrez voir des nouvelles et des messages récents. Cette route rend HTML, ce qui est agréable à regarder, mais difficile à interagir avec un programmeur. Au lieu de cela, les messages sont mis à la disposition des programmeurs en utilisant la route "/wp-json/wp/v2/posts".

La route "/wp-json/wp/v2/posts" nous indique qu'il s'agit d'une ressource WordPress ("/wp"), qu'il s'agit de la version 2 ("/v2/") de la ressource, et plus précisément que ce sont messages ("/messages"). Si vous ne l'avez pas déjà fait, visitez https://givewp.com/wp-json/wp/v2/posts et comparez ce que vous voyez avec https://givewp.com/blog/. Je vais vous donner un indice — c'est la même information !

Pour un exemple de la façon dont l'API REST est utilisée dans WordPress, considérez le dernier bloc de publications. Afin d'obtenir une liste de publications dans WordPress, le site devait traditionnellement faire une demande au serveur, puis restituer la page entière.

Le dernier bloc de publications peut demander uniquement les publications, puis se restituer. Il le fait en utilisant l'API REST. Et il peut le faire plusieurs fois pour interroger de nouveaux messages – sans restituer la page entière. Ceci est particulièrement utile lorsque vous envisagez d'éditer un site complet dans lequel des blocs sont utilisés pour éditer et afficher les composants de la page.

Chaque composant individuel peut demander les données dont il a besoin (y compris la vérification des mises à jour), puis restituer uniquement ce qui a changé.

Maintenant tu sais

Maintenant que vous avez compris le but et la structure d'une API REST WordPress, fouillez pour voir ce que vous pouvez trouver par vous-même. Pour un aperçu complet de l'utilisation et de l'extension de l'API REST de WordPress, consultez le Manuel de l'API REST.

N'oubliez pas : si quelqu'un vous pose des questions sur les API, vous ne pouvez pas commander de pancakes à Waffle House.

Pendant que vous peaufinez votre site, n'oubliez pas que les grands sites ont besoin d'un hébergement de qualité. Vous obtenez tout cela avec Managed WordPress by Nexcess. Avec des vitesses puissantes, des options d'évolutivité et un support exceptionnel, vous pouvez compter sur Nexcess pour alimenter votre site WordPress.

Venez voir pourquoi mieux est intégré avec Nexcess. Découvrez nos plans d'hébergement WordPress entièrement gérés dès aujourd'hui.

Ressources WordPress connexes

• WordPress.com contre WordPress.org
• 5 techniques avancées pour accélérer votre site WordPress
• Qu'est-ce que l'hébergement WordPress ?
• Le guide essentiel des plugins WordPress
• Comment choisir un hébergeur : ce qu'il faut rechercher et ce qu'il faut éviter