L’API de WooCommerce : Un guide rapide pour les débutants

L'API de WooCommerce Un guide rapide pour les débutants
L'API de WooCommerce Un guide rapide pour les débutants

L’un des avantages de WooCommerce est qu’il est construit sur une plateforme open-source.

Cela signifie que vous pouvez travailler avec l’API pour personnaliser WooCommerce selon vos propres besoins, ou même créer quelque chose qui peut être utilisé par de nombreux autres sites WooCommerce (comme nous l’avons fait avec Checkout WC).

Pour commencer toute sorte de personnalisation, vous devez vous familiariser avec l’API de WooCommerce, voici donc notre guide rapide pour les débutants :

Qu’est-ce que l’API WooCommerce ?

WooCommerce est conçu pour WordPress et, en tant que tel, possède une API REST. Cela signifie “Representational State Transfer” et permet le développement personnalisé, y compris l’interopérabilité entre différentes solutions en ligne.

Que signifie “interopérabilité” ? Cela signifie que vous pouvez conserver un grand nombre de données stockées dans un endroit comme WordPress, tout en interagissant avec ces données à partir d’une application totalement distincte. Auparavant, il fallait dépenser beaucoup d’argent pour développer des API personnalisées, mais aujourd’hui, les API REST sont présentes dans toutes les installations WordPress récentes.

REST se distingue des autres API car elle 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. Les données sont transmises via des points de terminaison HTTP en utilisant le formatage JavaScript Object Notation (JSON). Les points de terminaison représentent des pages, des articles et d’autres types de contenu WordPress.

À titre d’exemple, vous pouvez découpler vos données de l’API WordPress et l’utiliser pour créer des applications natives, ou pour automatiser la synchronisation des données. Actuellement, l’intégration de l’API de repos de WordPress est sur la v3 – le tableau ci-dessous, tiré de la documentation de WooCommerce, montre les versions de l’API et leurs versions associées de WooCommerce :

Pourquoi l’API REST est-elle importante pour les développeurs ?

Le formatage JSON de l’API REST permet à WordPress d’échanger des données avec tout autre site Web ou logiciel – écrit dans n’importe quel langage de programmation. Cela le rend extrêmement polyvalent pour les développeurs, car ils ne sont plus limités à PHP.

L’un des principaux avantages est qu’en normalisant la façon dont les applications interagissent avec les données de WordPress, le développement sur WordPress/WooCommerce deviendra plus facile et plus rapide pour les développeurs.

Que pouvez-vous faire avec l’API ?

En résumé, vous pouvez faire beaucoup de choses avec l’API ! L’API REST a été introduite pour la première fois en 2013 et a été ajoutée au noyau de WordPress en 2015. Il a des capacités puissantes pour ajouter des fonctionnalités à WP ou WooCommerce, bien qu’il semble souvent que seuls les développeurs avancés en profitent pleinement.

L’API REST peut être intégrée à des thèmes, des applications mobiles, des technologies vestimentaires, des systèmes hérités et plus encore. Voici quelques exemples :

  • Développez des applications basées sur vos produits/services en utilisant l’API pour accéder à l’infrastructure interne. (Voici un exemple d’Event Espresso).
  • Donnez aux développeurs/autres personnes la possibilité de créer leurs propres applications en utilisant une API pour développeurs.
  • C’est ce que fait Simmer pour créer des applications de recettes.
  • Syndiquer le contenu sur plusieurs sites.
  • Automatisez la synchronisation des données (voici un exemple de Wired).
  • Créez un tableau de bord WooCommerce personnalisé (voici un exemple de Cloudways).
  • Créer, mettre à jour ou supprimer des produits dans WooCommerce (voir cet exemple).
  • Tous ces exemples ici.

Comme vous pouvez le constater, l’accès et l’apprentissage de l’API REST vous donne de la flexibilité et ouvre de nouvelles possibilités de personnalisation et de développement. Ensuite, nous allons voir comment vous pouvez commencer à utiliser l’API WooCommerce…

Comment accéder à l’API WooCommerce

Voici quelques étapes pour commencer à utiliser l’API WooCommerce :

1. Activez l’accès à l’API dans WooCommerce

Pour ce faire, connectez-vous au back-end et allez dans WooCommerce>Paramètres>Avancés. Ensuite, allez sur l’onglet Legacy API et cochez la case pour “activer l’API REST existante”.

2. Ajouter et générer des clés API

Tout d’abord, cliquez sur l’onglet REST API pour ajouter une clé. Vous devrez ajouter une description, sélectionner un utilisateur et choisir des autorisations (l’accès en lecture/écriture est une bonne option pour permettre la création, la lecture, la mise à jour et la suppression des données WooCommerce).

Cliquez sur “générer une clé API” puis copiez votre clé de consommateur et votre secret de consommateur, à stocker quelque part en toute sécurité. Ce sont les éléments que vous utiliserez pour vous connecter à l’API de WooCommerce.

3. Téléchargez un client API

Un client API est un ensemble d’outils et de protocoles qui vous permet de contourner certaines opérations pendant que vous développez. Il s’occupe d’une grande partie des détails de bas niveau, comme les demandes et le traitement des réponses, pendant que vous écrivez votre code. C’est un moyen d’accélérer le développement en évitant de devoir “réinventer la roue” soi-même.

Insomnia et Postman sont des exemples de clients API que vous pouvez utiliser pour REST.

4. Utilisez vos clés API pour vous connecter à votre client API

Par exemple, si vous utilisez Insomnia, vous devez ouvrir l’application et cliquer sur “nouvelle demande”. Dans le menu déroulant “onglet de base”, cliquez sur “authentification de base”, puis entrez votre clé et votre secret de consommateur dans les formats suivants :

Nom d’utilisateur = clé du consommateur
Mot de passe = secret du consommateur.

5. Testez-le avec une requête GET

Une requête GET, où vous demandez à obtenir toutes les commandes, est un bon moyen de tester que votre clé API fonctionne.

Dans votre client API, sélectionnez “get” dans la liste déroulante et tapez votre adresse Web comme ceci : https://yourwebsite.com/wp-json/wc/v3/orders. Le système devrait commencer à extraire toutes les commandes de votre boutique. Si vous obtenez une erreur 401 “sorry you are not allowed to edit this resource”, il y a un problème et vous devez le résoudre – faites quelques recherches sur la résolution des problèmes liés à l’API REST de WooCommerce.

Voici d’autres exemples de requêtes get :

  • Extraire une commande particulière : https://yourcompany.com/wp-json/wc/v3/orders/{insérer l’ID de la commande}.
  • Extraire tous les produits : https://yourcompany.com/wp-json/wc/v3/products/
  • Extraire un seul produit : https://yourcompany.com/wp-json/wc/v3/products/{insert product ID} (en anglais)
  • Extraction de tous vos clients : https://yourcompany.com/wp-json/wc/v3/customers/

6. Testez la requête PUT

Une demande PUT est un bon moyen de tester que vous avez un accès en lecture et en écriture pour vos clés API. Par exemple, pouvez-vous mettre à jour une seule commande à partir du client API ? Voici comment tester cela :

  • Étape 1. Effectuez une requête Get pour une seule commande : https://yourcompany.com/wp-json/wc/v3/orders/{insert order ID}.
  • Étape 2. Cliquez sur le menu déroulant “get” et choisissez “put” à la place. Choisissez JSON dans la liste déroulante.
  • Étape 3. Mettez à jour quelque chose concernant la commande – par exemple, vous pouvez mettre à jour le statut de “processing” à “complete”. (Note : utilisez une sorte de commande “démo” pour cela).

Dernières réflexions

Ceci a été un guide rapide pour les débutants sur l’API de WooCommerce et les bases de ce que vous pouvez faire avec elle. L’un des aspects les plus intéressants est qu’il n’est pas difficile de démarrer et qu’il existe de nombreux articles et documents contenant des informations gratuites sur la façon dont vous pouvez essayer différentes choses avec l’API.

La bonne nouvelle, c’est que l’API REST a de nombreuses autres applications potentielles que les développeurs commencent tout juste à explorer. Il s’agit d’un outil puissant qui devrait donner lieu à des développements intéressants à l’avenir. Pour en savoir plus, veuillez contacter le support wordpress de weapzy.