API WordPress : que sont-elles et comment les utiliser

L’API WordPress JSON REST a créé un véritable buzz dans la communauté WordPress, offrant de nouvelles possibilités aux développeurs et aux créateurs de contenu.

Bien que cela puisse paraître complexe, comprendre des termes clés tels que JSON, REST et API peut simplifier la façon dont vous interagissez avec les nombreuses fonctionnalités de WordPress.

Qu'est-ce qu'une API ?

API signifie « interface de programmation d'application », qui est essentiellement un ensemble d'instructions et de normes de programmation permettant à différentes applications logicielles de communiquer entre elles.

Imaginez qu'une application logicielle donne des instructions à une autre : une API est l'ensemble de règles convenues qui régissent cette interaction. Lorsqu'un logiciel envoie des instructions à un autre, l'API facilite l'action ou fournit les informations nécessaires.

Vous pouvez considérer une API comme « l’interface utilisateur » entre deux systèmes logiciels, gérant la communication des données et l’exécution des tâches, mais invisible pour l’utilisateur final.

Exemples d'API

Avoir accès à une API est génial lorsque vous développez des applications Web. Lorsqu'une API est rendue publique, cela signifie que les développeurs ont créé des solutions alimentées par le service du logiciel. Souvent, ils éliminent le besoin de réinventer la roue pour de nombreuses tâches, puisqu’elles ont déjà été créées.

Amazon est un excellent exemple d’API. Amazon a publié son API afin que les développeurs puissent accéder facilement aux produits et à leurs informations. Avoir accès à cela permet de publier facilement des liens vers des produits sur Amazon, avec des prix mis à jour et la possibilité d'acheter.

Un autre exemple d’interaction d’API serait l’achat de billets de concert. Pour acheter officiellement des billets, vous devez saisir les informations de votre carte de crédit. Une API est utilisée pour envoyer les informations de votre carte de crédit à une application distante, qui vérifie ensuite que les informations de votre carte de crédit sont correctes.

Une fois que tout est vérifié, l'application distante renvoie une réponse au site Web de billets indiquant que vous pouvez continuer, auquel cas vous avez acheté les billets avec succès. Lorsque tout cela se passe, vous ne voyez qu’une seule interface, qui est le site Web des tickets. C'est un processus transparent ; En coulisses, de nombreuses applications travaillent ensemble à l'aide d'API, mais vous, en tant qu'utilisateur, ne remarquez pas quand les tâches sont transmises d'une application à une autre.

API et WordPress

Amazon et les achats de billets sont d’excellents exemples de la façon dont les API fonctionnent ensemble, mais comment cela s’applique-t-il à WordPress ?

Eh bien, toutes les mêmes idées s'appliquent. Avec l’API WordPress, vous pouvez transférer et extraire des données vers et depuis WordPress.

L'API est un outil clé que les développeurs peuvent utiliser pour partager facilement les données de leur site Web WordPress vers d'autres sites Web ou applications. Plus précisément, cette API vous permet d'effectuer des actions create , read , update et delete (CRUD) sur le contenu WordPress. Voici quelques exemples de types de contenu :

• Messages
• Types de publication personnalisés
• Pages
• Taxonomies
• Utilisateurs
• Médias

Que signifie REST ?

Il n'y a pas de sieste ni de ronflement ici : REST fait référence au style architectural d'une API. REST signifie Representational State Transfer.

Rappelez-vous comment nous avons mentionné qu'une API donne les détails de la communication afin que les programmes puissent communiquer entre eux ? Les API REST sont conçues de telle manière qu'elles fournissent une méthode de communication légère, qui permet d'économiser de la bande passante. C’est exactement ce que fait l’API WordPress JSON REST, ce qui en fait une excellente option lorsqu’il y a un volume élevé de données.

Nous venons d'effleurer la surface de REST ; si vous souhaitez en savoir plus, consultez ce didacticiel utile REST.

Format JSON

Pour accéder aux données, nous avons besoin d’une source à partir de laquelle puiser. C'est là qu'intervient JSON. JSON signifie JavaScript Object Notation.

JSON est facile à lire et à comprendre pour les humains et les machines. C'est le moyen idéal pour stocker des informations de manière organisée et facile d'accès. Parce que JSON est si simple d’accès, cela en fait un excellent choix pour la création d’API REST et constitue la solution parfaite pour l’API REST WordPress JSON.

Voici une idée de base de ce à quoi ressemble le format JSON :

[javascript]
{"employés":[
{"prénom":"Jane", "nom":"Smith"},
{"prénom":"Anna", "nom":"Olsen"},
{"prénom":"Josh", "nom":"Jones"}
]}

[/javascript]

Format JSON dans WordPress

JSON ne s'écrit pas tout seul, mais ne vous inquiétez pas, vous n'avez pas besoin de créer manuellement le fichier JSON. Il existe des plugins qui peuvent le créer pour vous. Avec l'un de ces outils, les données du site seront dans le format correct, y compris les utilisateurs, les publications, les pages, les taxonomies, etc.

Utilisation de l'API REST JSON

L'utilisation de l'API est assez explicite ; vous récupérerez les données de votre site au format JSON simple. Et si vous avez installé un plugin, vous pouvez jouer en affichant les publications de votre site sous forme de données.

Récupérer ou mettre à jour des données est aussi simple que d’envoyer une requête HTTP. HTTP est un protocole de requête/réponse. Tout d’abord, vous envoyez une demande de données, puis les données sont renvoyées en réponse.

Méthode OBTENIR

La méthode GET est utilisée pour récupérer des informations et n'a aucun effet sur les données. Envoyez simplement une requête GET à /wp-json/wp/v2/posts . Vous voulez rechercher quelque chose ? Par exemple, si vous recherchez « développement », vous obtiendrez les résultats avec la requête GET /wp-json/wp/v2/posts?search=development .

Requête POST

Une requête POST est utilisée pour envoyer des données. Avec les capacités de la nouvelle API, par exemple, vous pourriez mettre à jour un utilisateur. Disons que vous souhaitez mettre à jour l'utilisateur avec l'ID 10. Tout ce que vous avez à faire est d'envoyer une requête POST à /wp-json/wp/v2/users/10 .

Pour essayer cela, nous vous recommandons d'utiliser Postman, une extension de Google Chrome.

Plus de Javascript dans le mix

Backbone.js et API

Backbone.js est un excellent moyen de travailler avec l'API car il s'agit d'un framework conçu pour travailler avec les API REST. L'API WordPress comprend une API Javascript facile à utiliser basée sur des modèles Backbone. Cela permet aux développeurs de plugins et de thèmes d’être opérationnels sans efforts ni connaissances très approfondis sur les détails de la connexion.

Il y a bien plus à faire, mais Backbone structure les applications Web en fournissant des modèles, des collections et des vues, et connecte le tout à l'API WordPress via une interface REST JSON.

Qu’est-ce que cela signifie pour les développeurs WordPress ?

Avec la disponibilité de l’API WordPress, de nouvelles façons de l’utiliser se sont multipliées et continueront de le faire à mesure qu’elle gagnera en popularité. L'API WordPress peut améliorer à peu près n'importe quelle fonctionnalité WordPress existante qui repose sur Javascript. Voici quelques exemples :

• validation/soumission du formulaire
• Thèmes ou plugins Backbone.js
• défilement infini

C'est également un excellent moyen d'afficher du contenu provenant d'autres sources. Désormais, il est facile d'afficher le contenu d'un site individuel dans une configuration multisite. Il est également possible d'afficher le contenu d'un site WordPress entièrement distinct. En plus d'afficher le contenu, celui-ci peut également être mis à jour plus facilement et plus efficacement.

Maintenant que nous avons passé en revue une partie de la terminologie de base, nous savons que JSON est la notation, REST est le style architectural et API est l'interface qu'ils constituent. Connaître les bases de l’API et ses capacités vous assurera de bien démarrer lorsque vous explorerez les nouvelles possibilités de l’API WordPress.