Principes de base de l'API WordPress : ce que cela signifie et comment l'utiliser
Publié: 2016-03-03Vous avez peut-être entendu parler de l'API WordPress JSON REST. C'est une grande nouvelle pour les utilisateurs de WordPress et un motif de célébration !
JSON, REST, API - c'est beaucoup de jargon pour un seul nom, alors décomposons tout.
Qu'est-ce qu'une API ?
API signifie « interface de programmation d'application », qui est un ensemble d'instructions de programmation et de normes permettant d'accéder à une application logicielle ou à un outil Web basé sur le Web. Imaginez le "logiciel un" qui donne des instructions au "logiciel deux". Une API est un accord entre les deux et les lignes de communication sont ouvertes. Fondamentalement, ce qu'ils se disent est quelque chose du genre "lorsque vous me donnez une instruction, j'exécute l'action ou je renvoie les informations correctes".
Lorsque nous recherchons sur le Web et utilisons diverses solutions logicielles, nous sommes habitués aux interfaces utilisateur avec des mises en page, des boutons et des graphiques spécifiques avec lesquels nous interagissons pour accomplir les tâches souhaitées. Tout cela est inutile pour une machine car tout ce qui les intéresse, ce sont les données, ce qu'elles doivent faire et comment elles interagissent avec elles. Une API est l'alternative du logiciel à «l'interface utilisateur», donnant des instructions à un deuxième logiciel sur la façon d'obtenir des données et d'autres tâches spécifiques. Ils sont totalement invisibles pour les utilisateurs qui utilisent l'application Web et constituent simplement une interface de logiciel à logiciel.

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 la nécessité de réinventer la roue pour de nombreuses tâches, car ils ont déjà été créés.
Un excellent exemple d'API est Amazon. Amazon a publié son API afin que les développeurs puissent accéder facilement aux produits et à leurs informations. L'accès à cela facilite la publication de liens vers des produits sur Amazon, avec des prix mis à jour et la possibilité d'acheter.
Un autre exemple d'API interagissant serait l'achat de billets de concert. Pour acheter officiellement des billets, vous devez entrer les informations de votre carte de crédit. Une API est utilisée pour envoyer vos informations de carte de crédit à une application distante, qui vérifie ensuite que les informations de carte de crédit sont correctes. Une fois que tout est vérifié, l'application distante renvoie une réponse au site Web de billetterie indiquant que vous pouvez continuer, à quel point 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 de la billetterie. C'est un processus transparent; dans les coulisses, de nombreuses applications fonctionnent ensemble à l'aide d'API, mais vous, en tant qu'utilisateur, ne remarquez pas lorsque des 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 extraire et extraire des données de WordPress.
L'API est un outil clé que les développeurs peuvent utiliser pour partager facilement des 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 de create , de read , de mise à update et de delete (CRUD) sur le contenu WordPress. Voici quelques exemples de types de contenu :
- Des postes
- Types de publication personnalisés
- pages
- Taxonomies
- Utilisateurs
- Médias
Que signifie REPOS ?
Il n'y a pas de sieste ou de ronflement ici, mais 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 spécificités de la communication afin que les programmes puissent communiquer entre eux ? Les API REST sont conçues de manière à fournir une méthode de communication légère, qui économise 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 de gratter la surface de REST ; Si vous souhaitez en savoir plus, consultez ce tutoriel utile REST.
Format JSON
Pour accéder aux données, nous avons besoin d'une source à partir de laquelle extraire. 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 créer des API REST et constitue la solution parfaite pour l'API WordPress JSON REST.
Voici une idée de base de ce à quoi ressemble le format JSON :
{"employees":[
{"firstName":"Jane", "lastName":"Smith"},
{"firstName":"Anna", "lastName":"Olsen"},
{"firstName":"Josh", "lastName":"Jones"}
]}
Format JSON dans WordPress
JSON ne s'écrit pas simplement, mais ne vous inquiétez pas, vous n'avez pas à créer manuellement le fichier JSON. Il existe un excellent plugin qui le crée pour vous. Avec cet outil, les données du site seront au format correct, y compris les utilisateurs, les publications, les pages, les taxonomies, etc. Le plugin peut être trouvé ici. En outre, il existe une documentation utile qui vous sera utile lorsque vous commencerez.

Utilisation de l'API REST JSON
L'utilisation de l'API est assez explicite ; vous saisirez les données de votre site au format JSON simple. Et si le plugin est installé, vous pouvez jouer avec la visualisation des 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 GET
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 chercher 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 .
Demande POST
Une requête POST est utilisée pour envoyer des données. Avec les capacités de la nouvelle API, par exemple, vous pouvez mettre à jour un utilisateur. Supposons que vous souhaitiez 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, je vous recommande d'utiliser Postman, une extension 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 cadre 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 de se lancer sans effort ni connaissance approfondie des détails de la connexion. Il y a beaucoup plus, 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 tout cela signifie pour les développeurs WordPress ?
Avec la disponibilité de l'API WordPress, de nouvelles façons de l'utiliser ont augmenté et continueront de le faire à mesure qu'elle gagne 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éfilé interminable
C'est aussi 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 séparé. En plus d'afficher du contenu, le contenu peut également être mis à jour.
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 un bon départ lorsque vous explorerez les nouvelles possibilités avec l'API WordPress.
