API WooCommerce : Comment l’utiliser

WordPress est actuellement le CMS le plus populaire. Pourquoi ? Parce qu’il s’intègre facilement à des milliers d’outils permettant d’améliorer les performances et les fonctionnalités de votre site web.

Ces outils couvrent un large éventail de secteurs, mais les utilisateurs sont toujours impressionnés par le nombre d’outils disponibles pour le commerce électronique. L’un des outils de commerce électronique les plus puissants est l’API WooCommerce.

Comprendre l’API WooCommerce

L’API WooCommerce comporte trois composants principaux. Pour comprendre la puissance de cette API, examinons chacun de ces composants individuellement.

API REST

L’API REST de WooCommerce permet aux utilisateurs d’accéder à leur boutique WooCommerce depuis l’extérieur de leur site web. Cette conception vous permettra d’accéder à votre boutique à partir d’autres applications Internet telles que Shopify, par exemple.

En fin de compte, l’API REST facilite la gestion de votre boutique. Vous pouvez accéder à votre boutique WooCommerce à partir des tableaux de bord d’autres applications tout en conservant l’accès à toutes les fonctionnalités d’administration de WooCommerce.

API héritée (legacy API)

L’activation de l’API héritée était auparavant la méthode utilisée pour activer votre API pour WooCommerce. Cependant, cette partie du processus est en train de devenir obsolète dans les versions plus récentes.

La version la plus récente est l’API REST WooCommerce. Elle s’intègre directement à l’API de WordPress. L’API héritée est l’ancienne version de WooCommerce. Les utilisateurs doivent vérifier leurs paramètres, car WooCommerce a tendance à lancer l’API héritée par défaut.

Webhooks

Les webhooks permettent à WooCommerce d' »appeler » d’autres applications. Par exemple, vous créez un plugin WooCommerce, si vous souhaitez que des actions dans WooCommerce soient déclenchées par des actions effectuées dans d’autres applications, vous pouvez utiliser un webhook.

L’API accomplit cela à l’aide d’URL. Vous pouvez envoyer une alerte de notification via l’API à une URL spécifique. Ces URL peuvent provoquer des événements sur un site particulier, déclenchant une autre action sur un site ou une page distincte.

Terminologie clé de l’API WooCommerce

En parcourant la documentation de l’API WooCommerce, vous rencontrerez une terminologie propre à WooCommerce. Passons en revue ces termes et définitions pour vous aider dans votre processus API.

Format de requête/réponse

Il s’agit du format que WooCommerce utilisera pour transmettre certains types de données. Il est important de connaître les différents types de données, car certaines URL et certains déclencheurs ne fonctionneront pas s’ils ne reçoivent pas les données dans le format approprié.

Le format standard pour la plupart des données dans l’API WooCommerce est JSON. Les dates du calendrier sont renvoyées sous forme d’entiers, et tous les nombres (comme les montants, les prix ou les totaux) sont exprimés sous forme de chaîne de texte et comportent par défaut deux décimales. Tout ce qui est laissé vide sera renvoyé sous forme de chaîne vide ou « null ».

Authentification

Le processus d’authentification permet l’intégration de l’API WooCommerce. Les utilisateurs peuvent connecter l’API à d’autres plateformes à l’aide de clés API.

Pour générer une clé API WooCommerce, vous devez accéder à vos paramètres. Deux clés sont disponibles pour les utilisateurs de WooCommerce : une clé secrète et une clé consommateur.

Les clés de consommateur sont également appelées clés générales ou clés API. Ces clés sont attribuées à un utilisateur à partir de différentes plateformes. Les clés API WooCommerce vous permettent de vous connecter à d’autres plateformes telles que WordPress, Shopify, etc.

La clé secrète fonctionne de manière similaire pour certaines applications et plateformes. Lorsque vous connectez des outils ou des applications tiers à WooCommerce, la clé générale ou la clé de consommateur sert de « nom d’utilisateur » pour vos identifiants de connexion, tandis que la clé secrète sert de mot de passe.

Points de terminaison (endpoints)

En termes de technologie API, un point de terminaison est le point auquel l’API interagit avec une autre application ou plateforme. Un exemple de point de terminaison serait l’URL d’une plateforme spécifique, comme Shopify ou Facebook.

le CRUD :

Selon Wikipedia, l’acronyme informatique anglais CRUD (pour Create, Read, Update, Delete) désigne les quatre opérations de base pour la persistance des données, en particulier le stockage d’informations en base de données.
On peut donc créer, lire (et récupérer), mais aussi mettre à jour, et supprimer les données.

Configuration de l’API WooCommerce

Le processus de configuration de votre API WooCommerce est relativement simple. Suivez les étapes ci-dessous pour relier tous vos outils à la plateforme et transformer l’expérience d’achat en ligne de vos clients.

Vous devrez naviguer dans les menus suivants de votre tableau de bord WordPress :

WooCommerce > Paramètres > Avancé > API Rest

Une case à cocher permet d’indiquer si l’API est activée ou non. Assurez-vous que la case est cochée, cliquez sur « Enregistrer les modifications » et l’accès à l’API est désormais disponible.

Comment créer des clés API dans WooCommerce

Les clés API sont la colonne vertébrale des fonctions API de WooCommerce. Il est temps d’en créer pour connecter vos outils et plateformes préférés. Suivez les étapes ci-dessous pour ce faire.

Ajouter une clé

Vous devrez créer une nouvelle clé pour chaque application ou plateforme que vous connectez à WooCommerce. L’API générera une clé consommateur et une clé secrète pour chaque nouvelle connexion que vous créerez.

Vous devrez vous rendre dans le menu API REST pour ajouter une clé. Voici comment le trouver :

WooCommerce > Paramètres > Avancé > API REST

Une fois que vous y êtes, cliquez sur Ajouter une clé.

Configurer les paramètres de la clé

Une fois que vous avez cliqué sur « Ajouter une clé », vous devrez prendre certaines décisions. Pour chaque clé que vous créez, vous devrez configurer les paramètres suivants :

Description : c’est ici que vous pouvez « nommer » chaque clé pour la plateforme correspondante afin de faciliter leur organisation.
Propriétaire : attribuez une clé à l’utilisateur spécifique qui en est responsable au sein de votre équipe.
Autorisations : elles déterminent les fonctions que vous accordez à cette clé particulière. Par exemple, si vous avez besoin d’une clé spécifique pour supprimer ou modifier des données, vous devrez accorder des « autorisations de lecture/écriture ».

Génération de l’API

Une fois la configuration de vos paramètres terminée, cliquez sur le bouton « Générer une clé » en bas de l’écran. La page suivante contient une clé consommateur et une clé secrète, ainsi qu’un code QR pour cette connexion.

Une fois que vous avez quitté la page de génération de l’API, vous ne pouvez plus y revenir. Copiez donc ces clés dans un autre document Word ou Notes et conservez-les. Vous en aurez besoin pour vous connecter à votre configuration WooCommerce.

Utilisation des clés pour se connecter à des applications tierces

Maintenant que vos clés API sont générées, nous pouvons commencer à nous connecter à des applications et plateformes tierces, appelées « clients API ». Vous devrez suivre les étapes des deux côtés de la connexion dans le menu WooCommerce de WordPress et dans l’application de votre choix.

Chaque plateforme est différente, vous devrez donc accéder aux ressources d’aide de la plateforme en question. Recherchez des conseils sur la manière d’accéder aux informations d’identification d’autorisation de l’application.

La plupart des plateformes proposent plusieurs types d’autorisation. Vous devrez sélectionner « Autorisation de base ».

Copiez et collez votre clé API générale ou consommateur dans la barre « Nom d’utilisateur » et utilisez votre clé secrète comme mot de passe. Vous avez ainsi connecté avec succès WooCommerce à l’un de vos autres puissants outils de commerce électronique. L’étape suivante consiste à commencer à effectuer des requêtes API.

Comment effectuer des requêtes API WooCommerce

C’est dans les requêtes API que la magie opère. Ces requêtes rendent possibles toutes les fonctions « sympas » qui vous faciliteront la vie. Ces requêtes se présentent sous deux formats : GET ou PUT. Suivez les étapes ci-dessous pour les configurer entre les outils.

Tester une requête GET

Comme leur nom l’indique, les requêtes GET sont utiles pour obtenir des données provenant d’autres sources. Un exemple pratique dans le domaine du commerce électronique serait d’obtenir une liste de vos produits WooCommerce. Cela nécessite certaines connaissances techniques, mais si vous suivez les instructions, tout devrait bien se passer.

Pour exécuter cette fonction GET, vous devez saisir l’URL suivante :

https://monsite.com/wp-json/wc/v3/products

Bien sûr, vous devrez remplacer « monsite » par votre URL. Une fois exécutée, cette requête GET extraira toutes les données relatives à vos produits répertoriés dans WooCommerce.

L’intégration de l’API WooCommerce vous renverra ces données au format JSON. Si tout se passe bien, la plateforme que vous connectez à WooCommerce analysera ces données afin qu’elles soient présentées dans un format facile à utiliser pour vos utilisateurs finaux.

Si vous exécutez cette fonction GET et recevez un code 401 ou un autre code numérique, cela signifie qu’il y a une erreur. Vous devrez peut-être revenir en arrière ou consulter davantage les ressources d’aide de la plateforme pour résoudre le problème. Si la requête GET est effectuée correctement, vous devriez voir la chaîne JSON dans la section « Body » de votre tableau de bord.

Tester une requête PUT

À l’aide des données de notre requête GET à l’étape 1, vous devrez également vérifier une requête PUT. Pour notre exemple, supposons que le produit que nous utilisons pour cette requête ait un identifiant de produit de 101. Pour exécuter la requête GET, notre URL sera légèrement différente :

https://monsite.com/wp-json/wc/v3/products/101

Le processus pour transformer cette fonction GET en fonction PUT est simple :

À côté du champ URL, vous trouverez un menu déroulant.
Sélectionnez-le et remplacez la fonction GET par PUT.
Dans le volet Corps du tableau de bord, choisissez l’option « Brut ».
Ouvrez le menu déroulant « text » et sélectionnez JSON.
Une fois ces étapes terminées, vous pouvez maintenant effectuer votre requête. Vous pouvez par exemple utiliser cette fonction si vous souhaitez modifier le prix du produit n° 101. Pour ce faire, vous devez saisir le texte suivant :

{
"regular_price": "50"
}

Ensuite, vous pouvez afficher les résultats sur votre site en cliquant sur « Send ».

Requêtes WooCommerce API utiles pour votre e-commerce

Plusieurs requêtes API vous seront utiles dans votre boutique en ligne. Il vous faudra peut-être faire des recherches pour trouver une requête API qui correspond exactement à ce que vous recherchez, mais nous vous en proposons quelques-unes ci-dessous pour vous aider à démarrer.

Requêtes GET

Voici les URL de certaines requêtes GET que vous pouvez mettre en œuvre dans votre boutique en ligne :

Obtenir tous les produits : https://monsite.com/wp-json/wc/v3/products/
Obtenir tous les clients : https://monsite.com/wp-json/wc/v3/customers/
Obtenir un seul client : https://monsite.com/wp-json/wc/v3/customers/{ID client}
Obtenir toutes les catégories de produits : https://monsite.com//wp-json/wc/v3/products/categories
Obtenir une variante de produit : https://monsite.com/wp-json/wc/v3/products/{ID du produit}/variations/{ID de la variante}
Obtenir un seul produit : https://monsite.com/wp-json/wc/v3/products/{ID du produit}

Requêtes PUT

Voici quelques requêtes PUT de base qui pourraient vous être utiles pour votre boutique.

Mettre à jour les attributs d’un produit (couleur, taille, etc.)

{
    "id": 1,
    "slug": "pa_color",
    "type": "select",
    "order_by": "name",
    "has_archives": true,
    "_links": {
        "self": [
            {
                "href": "https://exemple.com/wp-json/wc/v3/products/attributes/6"
            }
        ],
        "collection": [
            {
                "href": "https://exemple.com/wp-json/wc/v3/products/attributes"
            }
        ]
    }
}

Mettre à jour le nom complet du client

{
"first_name" : "Paul",
"last_name" : "Durand"
}

Mettre à jour le prix d’un produit pour une variante

{
"regular_price" : "81"
}

Utiliser une seule requête pour mettre à jour le prix et la quantité en stock

{
"regular_price" : "50",
"stock_quantity" : 30
}

Mettre à jour l’adresse de livraison

{
    "expédition" : {
    "prénom" : "Jeanne",
    "nom" : "Doe",
    "entreprise" : "Jeanne Martin Broderies",
    "adresse_1" : "Rue de l'église",
    "adresse_2" : "BP 5",
    "ville" : "Pontarlier",
    "code postal" : "25300",
    "pays" : "France"
    }
}

Mettre à jour un avis sur un produit

{
    "id": 20,
    "date_created": "2018-09-08T21:47:19",
    "date_created_gmt": "2018-09-09T00:47:19",
    "product_id": 31,
    "status": "approved",
    "reviewer": "Paul Durand",
    "reviewer_email": "paul.durand@exemple.com",
    "review": "Merci pour le boulot.",
    "rating": 5,
    "verified": true,
    "reviewer_avatar_urls": {
        "24": "https://secure.gravatar.com/avatar/908480753c07509e76322dc17d305c8b?s=24&d=mm&r=g",
        "48": "https://secure.gravatar.com/avatar/908480753c07509e76322dc17d305c8b?s=48&d=mm&r=g",
        "96": "https://secure.gravatar.com/avatar/908480753c07509e76322dc17d305c8b?s=96&d=mm&r=g"
    },
    "_links": {
        "self": [
            {
                "href": "https://exemple.com/wp-json/wc/v3/products/reviews/20"
            }
        ],
        "collection": [
            {
                "href": "https://exemple.com/wp-json/wc/v3/products/reviews"
            }
        ],
        "up": [
            {
                "href": "https://exemple.com/wp-json/wc/v3/products/31"
            }
        ],
        "reviewer": [
            {
                "embeddable": true,
                "href": "https://exemple.com/wp-json/wp/v2/users/1"
            }
        ]
    }
}

Utilisation avancée de l’API WooCommerce

En plus des fonctionnalités de base, les utilisateurs peuvent également exploiter l’API WooCommerce pour gérer certaines fonctions avancées de leur boutique en ligne. Voici quelques-unes des fonctionnalités avancées de WooCommerce :

Pagination personnalisée : l’API WooCommerce permet aux utilisateurs de créer un nombre d’articles personnalisé par page afin de s’adapter au style et à la mise en page de leur site web.

Webhooks : les utilisateurs peuvent programmer des webhooks WooCommerce pour déclencher des événements sur d’autres sites web. Les boutiques en ligne peuvent utiliser cette fonctionnalité pour faciliter les options d’expédition, l’emballage, le processus de retour et bien plus encore avec WooCommerce.

Tâches asynchrones : les boutiques peuvent déclencher des tâches asynchrones qui s’exécutent séparément après le paiement d’une commande ou la création d’un compte client auprès de votre marque.

Filtrage et tri des données : vous pouvez ajouter des champs personnalisés aux produits WooCommerce et mettre en place des fonctionnalités de tri personnalisées afin d’améliorer l’expérience client.

Bonnes pratiques et conseils pour WooCommerce

L’API WooCommerce vous offre une grande liberté pour personnaliser votre boutique en ligne. Il est important de ne pas « sur-personnaliser » et d’ajouter trop de « fioritures » à votre boutique en ligne. Voici quelques bonnes pratiques à garder à l’esprit lorsque vous personnalisez votre boutique en ligne.

Utilisez un plugin

Si vous prévoyez uniquement d’apporter des modifications mineures à votre boutique, vous pouvez envisager d’utiliser ou de créer un plugin WordPress. Tout est géré dans le tableau de bord et ne nécessite pas de code ou de chaînes de texte supplémentaires.

JetPack pour WordPress est un plugin utile pour la personnalisation de base de WooCommerce (bien qu’un peu lourd). Si les mises à jour que vous effectuez ne concernent que des modifications de la feuille de style ou du flux CSS, cette option est faite pour vous.

De plus, il existe de nombreuses options de plugins CSS si vous souhaitez disposer d’un CSS global qui ne soit pas perdu lorsque vous modifiez le thème actif ou le thème enfant.

Utilisez un thème enfant

Après avoir mis à jour la feuille de style ou le CSS, ceux-ci peuvent être réinitialisés à chaque mise à jour de votre site web. Pour conserver vos personnalisations alors que WordPress continue de mettre à jour votre site, envisagez d’utiliser un thème enfant (Child theme).

Le thème enfant vous permet d’apporter des modifications sans ajouter de code. De plus, les modifications que vous apportez s’appliquent au thème parent, ce qui vous permet d’effectuer des mises à jour en toute sécurité afin d’améliorer l’expérience client globale.

Alternative souvent négligée ou méconnue, il est également possible de développer un plugin enfant, l’intérêt réside dans le fait que votre fonctionnalité n’est pas attaché à un thème spécifique, même si elle requiert l’utilisation (et l’installation) d’un plugin tiers.

Bonus

Si vous la documentation officielle vous semble un peu ardue, vous n’êtes pas seul.
Nous avons donc créé notre propre documentation : 9000 pages de hooks et fonctions woocommerce, illustré d’un exemple contextualisé.

---