Découvrir les routes et endpoints de l’API de WordPress

L’interaction avec l’API de WordPress se fait en accédant à ce que l’on appelle des routes et des points de terminaison (« endpoints » en anglais).

Ces deux termes sont intimement liés donc on va tenter de les expliquer ensemble.

Lorsqu’on détaillait le fonctionnement d’une API REST, nous avons vu ensemble qu’elle respecte des contraintes d’architecture précises, dont l’une est l’utilisation des méthodes HTTP, comme GET, POST, PUT ou encore DELETE pour requêter ces fameux points de terminaison. Chacun de ces endpoints exécute en tâches de fond une fonction spécifique en prenant un ou plusieurs arguments pour retourner les données adéquates.

Une route est l’adresse Web que vous allez utiliser pour accéder aux endpoints disponibles. En clair, la route est une URL et le point de terminaison ou endpoint est l’action exécutée derrière cette URL.

Prenons un exemple pour que cela soit plus parlant.

Supposons que je veuille obtenir le contenu d’un article en particulier de WordPress celui avec l’ID 123. Je peux y accéder via la méthode GET depuis l’URL wp/v2/posts/123. Ce point de terminaison récupère dans la base de données la ressource avec l’ID 123 et renvoie sous la forme d’un objet JSON le contenu de l’article. Depuis la même route, il existe aussi d’autres endpoints via les méthodes PUT ou DELETE pour respectivement mettre à jour ou supprimer le contenu. Ces deux derniers demande une authentification à l’API pour vérifier les privilèges qui sont accordés à votre compte WordPress.

Liste des routes & endpoints de WordPress

RessourcesRoutes
Articles/wp/v2/posts
Catégories/wp/v2/categories
Étiquettes/wp/v2/tags
Pages/wp/v2/pages
Commentaires/wp/v2/comments
Taxonomies/wp/v2/taxonomies
Média/wp/v2/media
Utilisateurs/wp/v2/users
Types de contenu/wp/v2/types
Réglages/wp/v2/settings
Thèmes/wp/v2/themes
Extensions/wp/v2/plugins
Recherche/wp/v2/search
Blocs de contenus/wp/v2/block-types
Blocs réutilisables/wp/v2/blocks
Rendu des blocs/wp/v2/block-renderer

Pour Aller plus loin :