Tutoriel de l'API REST WordPress - Guide du débutant

Êtes-vous à la recherche d’un didacticiel sur l’API REST WordPress adapté aux débutants? Alors vous êtes au bon endroit! Dans cet article, nous allons vous présenter le projet API REST WordPress, expliquer pourquoi il est si important et vous donner un aperçu de son utilisation.

Introduction à l’API REST WordPress

Page d'accueil du projet WP REST API

DU REPOS (Transfert d’État représentatif) L’API est un style d’architecture logicielle qui détermine la manière dont les services Web communiquent entre eux à l’aide du protocole de transfert HyperText.

En juin 2013, Ryan McCue et Rachel Baker de WordPress a téléchargé le projet d’API REST sur GitHub. Après avoir obtenu beaucoup de soutien du public et près de 100 contributeurs pour de futures améliorations, le projet a été ajouté au noyau WordPress de Décembre 2015

À l’heure actuelle, presque tous les professionnels qui travaillent avec WordPress ont entendu parler de l’API REST. Cependant, depuis son intégration principale, seuls les développeurs avancés ont pris le temps d’apprendre à quel point cette nouvelle fonctionnalité peut être puissante. C’est très malheureux car cet outil peut ouvrir des possibilités infinies pour développer votre site Web WordPress.

L’API REST de WordPress est conçue pour fournir une API intégrée qui peut être intégrée dans des thèmes, des applications mobiles, etc. Avec lui, WordPress peut interagir avec n’importe quelle application et les développeurs peuvent même l’utiliser pour créer leurs propres API.

Voici quelques façons de l’utiliser dans vos projets, inspirées d’exemples du monde réel:

  • Espresso événementiel Utilise l’API WordPress REST pour accorder l’accès à leur infrastructure interne et développer des applications en fonction de leurs services.
  • cuisinier, un plugin de recette WordPress, permet aux développeurs de créer leurs propres applications de recettes en utilisant les leurs API développeur.

Voici comment fonctionne l’API REST de WordPress

Il existe de nombreux types de Interfaces de programmation d’application (API) pour le moment, mais REST est une norme moderne. Il fonctionne en manipulant des données textuelles d’un endroit à un autre sans accès direct à une base de données ou à une interface utilisateur.

L’API REST est diffusée sur des points de terminaison HTTP (HyperText Transfer Protocol) à l’aide du format JSON (JavaScript Object Notation). Ces points de terminaison représentent les articles, pages et autres types de données WordPress.

Si vous n’avez jamais travaillé avec JavaScript Nous vous recommandons d’apprendre les bases de JSON premier. Cela vous aidera à mieux comprendre ce didacticiel de l’API REST WordPress.

Pourquoi l’API REST WordPress est importante pour les développeurs

Grâce au formatage JSON, WordPress permet à l’API REST de WordPress d’échanger des données avec d’autres sites Web et logiciels écrits dans n’importe quel langage de programmation. En conséquence, les développeurs ne sont plus limités à PHP et peuvent utiliser WordPress pour traiter les données via l’API REST.

L’accent croissant mis sur l’API soulève également des arguments en faveur du langage de programmation le plus important à apprendre. Étant donné que l’API REST est basée sur JavaScript, vous constaterez peut-être bientôt que JavaScript côté serveur peut remplacer PHP complètement.

Cette notion est étayée par le fait que le nouveau logiciel WordPress.com, Calypso, fonctionne entièrement sur JavaScript et API REST.

La standardisation de la façon dont les applications interagissent avec les données WordPress facilite également et accélère le développement de WordPress.

Pour cette raison, dans notre tutoriel sur l’API REST de WordPress, nous vous encourageons à accorder plus d’attention à cette fonctionnalité.

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

Dans ce tutoriel de l’API REST WordPress, nous utiliserons l’interface de ligne de commande (CLI) pour faire toutes les requêtes. Avec la CLI, vous pouvez facilement interagir avec l’API REST sans avoir à écrire des scripts supplémentaires pour demander et traiter les informations.

La première chose à faire est d’ouvrir un programme CLI sur votre ordinateur: Terminal pour MacOS et Linux et mastic Pour les fenêtres. Copiez ensuite votre adresse IP partagée ou dédiée et connectez-vous avec vos informations d’identification SSH.

Nous vous recommandons également d’utiliser un site de démonstration ou des tests locaux pour ce didacticiel. Assurez-vous également qu’il fonctionne également sur WordPress version 4.4 ou supérieure.

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

Nous commencerons notre tutoriel sur l’API REST WordPress en expliquant les concepts et termes clés:

  • Itinéraires & Points de terminaison – Une route est une URL que vous pouvez mapper à diverses méthodes HTTP, tandis qu’un point de terminaison est une connexion entre une seule méthode HTTP et une route. / wp-json / est un exemple d’itinéraire et inclut tous les points d’extrémité correspondants.
  • Demandes – une instance de WP_REST_Request. Il est utilisé pour stocker et récupérer des informations pour la demande en cours.
  • réponse – fournit les données que vous avez demandées ou renvoie une erreur pour vous informer de l’erreur.
  • Schème – vous montre une liste de toutes les propriétés et paramètres d’entrée que l’API REST peut accepter et renvoyer.
  • Classes de contrôleur – l’endroit où vous gérez les parties mobiles de l’API REST.

Étape 2: Rencontrez les points de terminaison d’API REST les plus utiles

Dans cette partie du didacticiel de l’API REST, nous allons vous montrer quelques points de terminaison d’API REST pratiques que vous pouvez tester avec votre site:

  1. Tout d’abord, vous voulez savoir comment effectuer un appel HTTP vers l’API REST. La base de chaque appel d’API REST WordPress est la suivante:
    http://yourdomain.com/wp-json/
  2. Ensuite, vous pouvez tester la connexion en exécutant le Boucles Commande dans votre CLI:
    curl -X OPTIONS -i http://yourdomain.com/wp-json/

    Vous devriez être invité avec un message HTTP réussi:

    HTTP/1.1 200 OK
    Date: Wed, 23 Oct 2019 19:51:41 GMT
    Server: Apache/2.4.29
    X-Robots-Tag: noindex
    Link: <http://yourdomain.com/wp-json/>; rel="https://api.w.org/"
    X-Content-Type-Options: nosniff
    Access-Control-Expose-Headers: X-WP-Total, X-WP-TotalPages
    Access-Control-Allow-Headers: Authorization, Content-Type
    Allow: GET
    Transfer-Encoding: chunked
    Content-Type: application/json; charset=UTF-8
  3. Ensuite, vous pouvez vider et répéter cette commande avec plusieurs points de terminaison. Cette fois, nous utilisons simplement la version GET de curl pour obtenir une liste JSON de vos publications WordPress. Vous pouvez utiliser la commande suivante pour ce faire:
    curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts

    Vous pouvez également utiliser cette commande pour vérifier tous les sites WordPress existants:

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

Si vous souhaitez voir plus d’exemples, l’API REST de WordPress offre un Manuel de référence cela contient de nombreux points de terminaison utiles.

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

Certaines actions et données de l’API REST sont publiques, tandis que d’autres nécessitent que vous vous connectiez en tant qu’administrateur. Cependant, puisqu’il s’agit d’une API REST, il n’y a nulle part où se connecter.

Pour contourner ce problème, vous pouvez vous authentifier lorsque vous passez un appel nécessitant un accès administrateur, tel qu’un appel téléphonique. B. Affichage du contenu non publié ou mise à jour d’un message.

Dans ce tutoriel, nous utiliserons l’API REST WordPress Auth de base Brancher. C’est un simple plugin réservé aux développeurs que vous pouvez utiliser pour apprendre l’API REST. Cependant, il n’est pas destiné aux sites en direct. Comment l’installer:

  1. Téléchargez l’API REST WordPress Auth de base Brancher.
  2. Connectez-vous à votre tableau de bord WordPress et accédez à Plugins -> Ajouter un nouveau. Cliquez dessus Télécharger le plugin Cliquez sur le bouton et sélectionnez le fichier zip du plugin.
  3. Aller à Plugins installés Menu et activez le plugin à partir de là.
  4. Après avoir installé Basic Auth, ouvrez l’interface de ligne de commande et authentifiez une demande d’API à l’aide de utilisateur Drapeau. Voici un exemple d’application de la méthode d’authentification utilisateur, en utilisant curl pour afficher les articles non publiés:
    curl -X GET --user username:password -i http://yourdomain.com/wp-json/wp/v2/posts?status=draft

Une fois que vous êtes familiarisé avec l’authentification de base, vous pouvez utiliser d’autres méthodes recommandées dans le Documentation de l’API REST.

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

Une fois que vous avez compris comment effectuer des appels de base à l’API REST à l’aide de la commande curl, vous pouvez passer au choix d’un article spécifique:

  1. Tout d’abord, listez tous vos messages comme avant:
    curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts
  2. Recherchez l’ID d’une publication que vous souhaitez mettre à jour. Vous devez ajouter un identifiant à la fin de votre requête pour sélectionner un article individuel:
    curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts/<ID>

Cette commande vous permet de choisir un ID spécifique pour n’importe quel point de terminaison d’API REST, qu’il s’agisse d’une publication, d’une page ou d’une taxonomie.

Étape 5: mettez à jour votre premier article WordPress à l’aide de l’API REST

Enfin, essayons d’envoyer une mise à jour sur le message que vous avez choisi. Dans ce didacticiel de l’API REST, nous allons essayer de renommer le titre de notre article à l’aide de la commande POST. N’oubliez pas de fournir les données d’authentification.

Les nouveaux changements seront partagés avec le Drapeau à la fin de notre commande.

  1. Dans cet exemple, vous transmettez une variable d’objet JavaScript personnalisée (Titre) à une valeur personnalisée (Mon nouveau titre):
    curl -X POST --user username:password http://yourdomain.com/wp-json/wp/v2/posts/PostID -d '{"title":"My New Title"}'

    Assurez-vous de remplacer le nom d’utilisateur, le mot de passe, l’identifiant de publication et le nom du titre par vos propres détails WordPress.

  2. Vous pouvez ensuite sélectionner à nouveau la publication individuelle pour examiner les nouvelles modifications:
    curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts/PostID

Toutes nos félicitations! Vous venez de faire vos premiers changements administratifs à l’aide de l’API REST de WordPress.

Conclusion

L’API REST est un ajout puissant au cœur de WordPress, et les développeurs ont commencé à découvrir ses fonctionnalités. Au fur et à mesure que vous apprenez à travailler avec, vous pouvez améliorer vos compétences et créer des applications qui utilisent les services de WordPress.

Dans ce didacticiel de l’API REST WordPress, vous avez appris les cinq étapes importantes pour maîtriser cette fonctionnalité:

  1. Familiarisez-vous avec les concepts clés de l’API REST.
  2. Découvrez les points de terminaison de l’API REST les plus utiles.
  3. Apprenez les bases de l’authentification API REST.
  4. Sélectionnez votre premier article WordPress avec l’API REST.
  5. Mettez à jour un article WordPress à l’aide de l’API REST.

Bien que ce didacticiel de l’API REST WordPress ne fasse qu’effleurer la surface de ses fonctionnalités, nous pensons que c’est toujours un bon point de départ avant de creuser plus profondément.

Avez-vous des questions? Faites-nous savoir dans la section commentaires ci-dessous!

auteur

Will Morris travaille pour WordCandy. Quand il n’écrit pas sur WordPress, il aime jouer sa routine de comédie stand-up sur le circuit local.



Source link

Recent Posts