Woo­Com­merce REST API : fonc­tion­ne­ment

L’API REST de Woo­Com­merce vous permet l’accès à distance à la zone d’ad­mi­nis­tra­tion de votre boutique Woo­Com­merce. Les opé­ra­tions de base telles que « Lire » ou « Créer » sont gérées par des requêtes HTTP. L’API REST de Woo­Com­merce peut être activée di­rec­te­ment dans le back-end.

Qu’est-ce qu’une API REST ?

Les res­sources d’un système pouvant être adressées par REST (Repre­sen­ta­tio­nal State Transfers) sont définies dans une API. Une telle interface fait partie des meil­leures solutions per­met­tant aux systèmes com­pa­tibles avec le Web de com­mu­ni­quer de manière simple et efficace entre le Client et le Serveur.

Chaque ressource se voit attribuer des pa­ra­mètres qui la décrivent tout en pouvant être modifiés. Les ar­chi­tec­tures REST sont réalisées à l’aide du protocole HTTP, toutes les res­sources pouvant être adressées via un URI unique (Uniform Ressource Iden­ti­fier). Les pa­ra­mètres sont ajoutés en tant que pa­ra­mètres URL, et l’accès aux res­sources se fait par les actions HTTP standard GET, POST, PUT et DELETE.

À quoi sert une API REST dans Woo­Com­merce ?

La ca­rac­té­ris­tique la plus im­por­tante de l’API de Woo­Com­merce pour des accès REST est son uni­ver­sa­lité. Elle a été conçue pour permettre à une boutique Woo­Com­merce d’interagir fa­ci­le­ment avec d’autres sites ou services sur Internet. Cette in­te­rac­ti­vité po­ly­va­lente avec d’autres ap­pli­ca­tions Web ne profite pas seulement aux dé­ve­lop­peurs, mais aussi à tous les uti­li­sa­teurs de la pla­te­forme de boutique, comme le prouvent ces exemples des avantages d’uti­li­sa­tion de l’API de Woo­Com­merce :

• Accès in­dé­pen­dant de la pla­te­forme : accéder di­rec­te­ment au tableau de bord Woo­Com­merce avec une ap­pli­ca­tion tierce ? C’est possible grâce à l’API REST.
• In­té­gra­tion facile de la logique com­mer­ciale : l’API REST de Woo­Com­merce permet d’intégrer fa­ci­le­ment dans le projet des logiciels et du matériel spé­ci­fiques à l’en­tre­prise, tels que des wearables ou les dis­po­si­tifs de suivi IoT.
• Syn­chro­ni­sa­tion optimisée de données : les en­tre­prises qui sou­hai­tent syn­chro­ni­ser des données sur dif­fé­rentes pla­te­formes et canaux avec leur boutique Woo­Com­merce disposent de l’interface adéquate avec l’API REST.
• In­dé­pen­dance vis-à-vis du back-end Woo­Com­merce : en activant l’API de Woo­Com­merce uni­ver­selle, vous vous rendez in­dé­pen­dant du back-end de Woo­Com­merce ou de WordPress. Vous pouvez à tout moment intégrer et utiliser votre propre espace d’ad­mi­nis­tra­tion.
• In­té­gra­tion facile de données de tiers : l’interface REST vous permet d’accéder fa­ci­le­ment à l’ensemble des données de tiers basées sur l’ap­pli­ca­tion.
• Lien avec des ap­pli­ca­tions mobiles : relier votre boutique Woo­Com­merce à une ap­pli­ca­tion mobile est nettement plus facile en passant par l’interface po­ly­va­lente.

Comment utiliser l’API REST de Woo­Com­merce : ins­truc­tions pas à pas

Si vous souhaitez utiliser l’API de Woo­Com­merce pour interagir avec d’autres ap­pli­ca­tions et services Web, vous devez d’abord l’activer en générant une clé API. De plus, il faut installer un Client pour l’accès REST. Nous avons résumé les dif­fé­rentes étapes pour vous dans les pa­ra­graphes suivants.

Étape 1 : générer une clé API REST dans Woo­Com­merce

Pour utiliser l’API REST de Woo­Com­merce, vous devez d’abord générer une clé API. Cette clé re­pré­sente une sorte de contrôle d’accès et sera utilisée ul­té­rieu­re­ment par Woo­Com­merce pour au­then­ti­fier des requêtes REST.

Voici comment générer une clé :

1. Connectez-vous au back-end de Woo­Com­merce ou de WordPress.
2. Appelez la position « Woo­Com­merce » du menu latéral gauche.
3. Cliquez sur « Réglages »
4. Passez à l’onglet « Avancé ».
5. Sé­lec­tion­nez la sous-rubrique « API REST ».
6. Cliquez sur « Ajouter une clé » ou « Créer une clé API ».

Close

Trois ca­rac­té­ris­tiques sont à saisir pour la clé : sous « Des­crip­tion », vous inscrivez une brève in­for­ma­tion qui vous permettra de re­con­naître la clé. Sur la ligne « Uti­li­sa­teur », vous sé­lec­tion­nez l’uti­li­sa­teur Woo­Com­merce pour lequel l’accès à l’interface doit être généré. Dé­ter­mi­nez sous « Droits » si l’uti­li­sa­teur doit avoir un accès seul en lecture ou en écriture, ou les deux.

Dès que vous confirmez vos saisies en cliquant sur « Générer une clé API », Woo­Com­merce crée deux chaînes de ca­rac­tères al­pha­nu­mé­riques, une clé client et une clé secret client, ainsi qu’un QRCode. Copiez les deux clés et en­re­gis­trez les chaînes de ca­rac­tères dans un document. Vous en aurez besoin ul­té­rieu­re­ment lorsque vous sou­hai­te­rez accéder à l’API Woo­Com­merce avec un Client REST.

Close

Étape 2 : té­lé­char­ger l’API Client

Une fois une clé générée, vous pouvez envoyer vos requêtes à l’interface du système de boutique. Cependant, il faut disposer d’un Client API qui permette d’envoyer des requêtes et d’afficher les réponses reçues.

Les Clients les plus po­pu­laires pour l’accès REST sont Insomnia et Postman. Les deux outils sont dis­po­nibles sous forme d’ap­pli­ca­tion de bureau pour Windows, macOS et Linux. Vous pouvez également utiliser Postman, que nous utilisons dans le cadre de notre tutoriel, comme ap­pli­ca­tion Web di­rec­te­ment dans le na­vi­ga­teur.

L’ins­tal­la­tion et la con­fi­gu­ra­tion de Postman fonc­tion­nent comme suit :

1. Appelez la page de té­lé­char­ge­ment de Postman et té­lé­char­gez la version cor­res­pon­dant à votre système.
2. Exécutez le fichier de con­fi­gu­ra­tion Postman en double-cliquant dessus.
3. Créez un compte Postman en sai­sis­sant une adresse email valide, un nom d’uti­li­sa­teur et un mot de passe. Vous pouvez aussi vous inscrire à l’aide d’un compte Google actif.
4. Saisissez les in­for­ma­tions demandées et envoyez des liens d’in­vi­ta­tion à vos collègues (si vous le souhaitez).

Close

Étape 3 : lancer une requête API Woo­Com­merce

Après la con­fi­gu­ra­tion, vous pouvez tester l’accès à l’API REST en envoyant une première requête. Pour ce faire, accédez à votre espace de travail et cliquez sur « Create new Request » (« Créer une nouvelle requête »).

Close

Pour le premier test, nous sé­lec­tion­nons une requête GET pour appeler des données. Dans Postman, cette méthode est sé­lec­tion­née par défaut, vous pouvez donc conserver ce choix. Sur la ligne d’adresse suivant le « GET », au lieu de woo­com­merce-domain.xyz, utilisez l’adresse de votre boutique Woo­Com­merce :

https://woocommerce-domain.xyz/wp-json/wc/v3/orders

Ensuite, insérez vos données pour l’au­then­ti­fi­ca­tion à l’aide de l’API REST de Woo­Com­merce. Il s’agit ici de savoir si l’accès REST se fait par HTTP ou HTTPS (re­com­mandé). Passez à l’onglet « Au­tho­ri­za­tion » (« Au­to­ri­sa­tion ») et, sous « Type », sé­lec­tion­nez soit « OAuth 1.0 » pour HTTP ou « Basic Auth » pour HTTPS. Saisissez ensuite les codes en­re­gis­trés pour votre clé client et votre clé secret client. Dans le cas de Basic Auth, la clé doit être saisie sous « Username » (« Nom uti­li­sa­teur ») et la clé secret sous « Password » (« Mot de passe »).

Close

Une fois l’au­then­ti­fi­ca­tion con­fi­gu­rée, vous appuyez sur le bouton « Send » (« Envoyer ») et la requête est lancée. Dans le cas de l’adresse définie ci-dessus, vous appelez toutes les commandes actuelles avec la requête GET. Postman présente le résultat dans la fenêtre in­fé­rieure au choix dans les formats JSON, XML, HTML ou Texte.

Close