Un guide simple de l'API WooCommerce

Publié: 2020-12-28

Il ne fait aucun doute que WordPress a rendu l'ensemble du processus de publication de votre site Web plus facile et plus simple que sur la plupart des autres plateformes. Pour preuve, vous pouvez simplement jeter un œil aux statistiques étonnantes sur l'utilisation du noyau WordPress. De plus, WooCommerce a fait la même chose pour le commerce électronique que WordPress pour la publication Web. En plus d'être convivial pour les débutants, il offre des outils conviviaux pour les développeurs tels que l'API WooCommerce pour optimiser votre site.

Dans cet article, nous présenterons l'API REST de WooCommerce et expliquerons en quoi elle se rapporte à la propre API de WordPress. Nous expliquerons également pourquoi vous voudriez utiliser cette technologie puissante et comment commencer.

Allons droit au but !

Présentation de l'API REST WooCommerce

L'API WooCommerce vous permet de mettre en œuvre des fonctionnalités personnalisées pour votre site au niveau logiciel. Vous pouvez coder d'une manière spécialement conçue pour s'intégrer à WooCommerce. En tant que tel, vous pouvez créer pratiquement n'importe quelle fonctionnalité ou fonctionnalité si vous avez le temps, les compétences et (potentiellement) le budget.

Afin de comprendre le fonctionnement de cette fonctionnalité clé, vous devez vous familiariser avec deux termes :

  • Transfert d'état de représentation (REST). Il s'agit d'un sujet compliqué, mais pour les besoins de cet article, REST est un type de « service Web » qui vous permet d'accéder à des éléments spécifiques d'une page Web.
  • Interface de programmation d'applications (API). Contrairement à une interface utilisateur graphique (GUI), il s'agit essentiellement d'un ensemble de crochets de code et de filtres qui vous permettent de travailler avec des points d'accès. Généralement, vous les coderez dans certains fichiers basés sur WordPress.

En d'autres termes, REST définit ce à quoi vous pouvez accéder sur votre site via du code, et l'API vous donne les outils pour tirer parti de cet accès. Ensemble, ils vous permettent d'apporter des changements significatifs au fonctionnement de votre site.

Comment l'API WooCommerce se rapporte à l'API REST WordPress

Lorsqu'elle a été introduite pour la première fois, l'API WooCommerce était une entité unique. En d'autres termes, il a été uniquement conçu pour accéder aux « points de terminaison » de WooCommerce et n'a affecté aucun autre élément de WordPress.

Cependant, une fois l'API WordPress REST introduite, les points de terminaison de WooCommerce ont été fusionnés pour créer un « go-to » global pour accéder à WordPress sous le capot. Même ainsi, il existe toujours de la documentation pour l'API WooCommerce. Si vous relisez l'introduction de ce document, l'histoire de l'API est largement décrite.

Pour les besoins de cet article, nous considérerons que « l'API WooCommerce » est la collection de points de terminaison spécifiques pour cette plate-forme de commerce électronique. Bien sûr, les points de terminaison principaux seront également utiles, nous en mentionnerons donc également quelques-uns. En bref, il est préférable de ne pas s'attarder à essayer de séparer ces deux API - elles sont désormais identiques.

Pourquoi vous pourriez vouloir utiliser l'API WooCommerce

Vous avez peut-être déjà compris pourquoi l'API REST de WooCommerce est une flèche excitante et puissante dans le carquois de votre magasin. Voici quelques-unes des raisons pour lesquelles vous pourriez envisager de l'utiliser :

  • Vous avez des fonctionnalités personnalisées à mettre en œuvre. Si vous ne trouvez pas ce dont vous avez besoin via des plugins, des thèmes ou des extraits de code supplémentaires, la création de la fonctionnalité vous-même peut être une option.
  • Les clients peuvent obtenir un frontal personnalisé. En utilisant les fonctionnalités plus larges de l'API WordPress REST, vous pouvez dissocier le front-end de votre site du back-end. Cela vous permet d'exploiter la puissance de WordPress sous le capot, tout en créant des mises en page et des conceptions en utilisant une autre langue.
  • Votre équipe peut utiliser des backends personnalisés. Tout comme vos clients peuvent bénéficier d'une expérience front-end unique, vous pouvez utiliser différentes parties de WooCommerce pour créer un tableau de bord back-end personnalisé. Vous pouvez inclure presque toutes les métriques ou données que vous souhaitez, en créant essentiellement votre propre interface utilisateur et plate-forme d'analyse.

Quelles que soient vos raisons, l'API WooCommerce offre des fonctionnalités très puissantes. Pour le démontrer davantage, examinons certaines des spécificités de cette API et voyons exactement où et comment elle peut être utilisée sur votre site.

Ce que vous pouvez réaliser en utilisant l'API WooCommerce (4 exemples)

Il est tentant de dire simplement « Tout est possible » en ce qui concerne l'API WooCommerce. Cependant, cela vaut la peine d'examiner quelques tâches courantes que vous pouvez rencontrer, ainsi que certains cas d'utilisation spécifiques.

1. Créer, mettre à jour et supprimer des produits

Étant donné que les produits de votre magasin sont l'élément vital de votre entreprise, l'API WooCommerce consacre de nombreuses options pour garantir que vous puissiez tous les gérer. Vous pouvez travailler avec pratiquement toutes les informations collectées dans WooCommerce, bien que certains points de terminaison soient en lecture seule. Il existe même des API distinctes pour des produits uniques, des variantes, des attributs et leurs termes, des taxonomies, des classes d'expédition et des avis.

Cela peut être utile de plusieurs manières. Par exemple, considérons un site de marché, où les utilisateurs téléchargent leurs propres produits. Vous pouvez créer un programme de téléchargement frontal pour vous aider à effectuer les tâches d'administration nécessaires en fonction des entrées des utilisateurs. Vous pouvez également modifier par lots de nombreuses critiques de produits connexes en fonction d'une demande d'utilisateur, supprimer des e-mails d'identification, et bien plus encore.

2. Traiter les commandes et leurs notes associées

Si les produits sont la pierre angulaire de votre magasin, les commandes sont le carburant de la fusée. En tant que telle, l'API WooCommerce offre de nombreuses fonctionnalités pour vous aider à gérer les commandes et les notes. Pratiquement toutes les propriétés trouvées dans WooCommerce sont accessibles, ainsi que les propriétés de facturation, d'expédition et de métadonnées associées.

Nous dirions que la majorité des utilisations de ce point de terminaison consisteront à répertorier les commandes d'une manière ou d'une autre. Même un simple extrait d'une ligne vous offre un pouvoir immense. Par exemple, une liste peut être analysée pour plusieurs mentions du même produit, comptabilisée pour les commandes où un multi-panier contenait un article spécifique, et bien plus encore.

La mise à jour par lots des notes de commande est une autre utilisation utile de cet aspect de l'API. Prendre une collection de commandes de Noël, les séparer en fonction du statut de chacune et organiser le JSON résultant dans une feuille de calcul pourrait vous aider à livrer les commandes plus rapidement et plus efficacement.

3. Ajuster les taux d'imposition et les classes

Les taxes sont un casse-tête pour de nombreux propriétaires de magasins, surtout lorsqu'il s'agit de commandes internationales. Comme il existe de nombreuses façons d'appliquer des taxes à différents taux, l'API WooCommerce offre plusieurs options pour travailler avec ces données. Les endpoints se déclinent en deux variantes :

  • Taux d'imposition : c'est là que le pourcentage réel est enregistré, ainsi que d'autres données d'identification.
  • Catégories d'impôts : il s'agit de larges gammes d'impôts auxquels les taux sont appliqués.

Par exemple, vous pouvez créer un taux de taxe de 20 % appliqué à la classe « Taux standard ». En fait, pouvoir mettre à jour les taux d'imposition par lots est une bonne utilisation de l'API WooCommerce. Un exemple plus unique serait une configuration dans laquelle un taux ou une classe de taxe est créé en fonction d'un attribut client spécifique. C'est idéal pour les situations où vous devez « qualifier » un client avant de l'enregistrer ou de l'envoyer au processus de paiement.

4. Définir les zones d'expédition, les emplacements et les méthodes

Si vous avez déjà essayé de travailler avec l'expédition dans WooCommerce, vous comprendrez à quel point cela peut être un champ de mines. Si vous vous trompez sur un élément, le client est directement impacté dans un domaine propice aux commentaires et critiques médiocres. Heureusement, l'API WooCommerce peut fonctionner avec tous les points de terminaison associés à l'expédition, tels que les zones, les emplacements et les méthodes.

Par rapport à d'autres aspects de l'API, il n'y a pas trop d'attributs avec lesquels travailler ici. Cependant, il existe encore de nombreuses options disponibles pour vous aider à travailler avec les données de votre magasin. Bien que vous souhaitiez souvent « définir et oublier » les informations d'expédition (étant donné leur complexité et leur impact sur l'expérience utilisateur), il existe encore des applications pratiques.

Par exemple, vous serez probablement attentif aux réglementations COVID-19 actuelles à la fois à l'échelle de l'État et du pays. Dans cet esprit, vous pouvez envisager d'utiliser une combinaison de points de terminaison pour restreindre l'expédition à certains endroits de manière temporaire. De plus, vous pouvez informer les utilisateurs de tout retard au moment de l'achat. Cela peut se produire sur l'écran de paiement ou via une communication de masse.

Comment commencer à utiliser l'API WooCommerce

L'API REST WooCommerce fonctionne via un système basé sur des clés numériques pour accorder l'accès et les autorisations. Ce processus d'authentification comporte deux étapes distinctes :

  • WooCommerce crée deux clés : une clé consommateur et une clé secrète . Ils sont constitués de chaînes de caractères aléatoires et sont pratiquement impossibles à déchiffrer.
  • Chaque fois que vous souhaitez effectuer un «appel» à l'API REST, vous devrez fournir ces clés comme preuve d'authentification.

Ce processus est simple, mais l'obtention de ces clés (et l'utilisation de l'API elle-même) nécessite que vous vous rendiez dans votre tableau de bord WooCommerce, en particulier sur l'écran WooCommerce > Paramètres > Avancé . Recherchez le lien API REST en haut, accédez à cet écran, puis cliquez sur le bouton Créer une clé API :

Cliquez sur le bouton Créer une clé API.

Ensuite, remplissez le champ Description , tout en laissant les autres tels quels pour l'instant. Il devrait s'agir d'une description simple de l'objet de l'accès :

Création d'une nouvelle clé et saisie des détails.

Enfin, sélectionnez le bouton Générer une clé API et attendez que WordPress fasse son travail. Vous verrez une clé consommateur et une clé secrète ici, un code QR pour une authentification supplémentaire et un lien pour révoquer l'accès à l'API à l'avenir. Il est important de copier les clés maintenant, car vous ne pourrez pas les récupérer plus tard.

À ce stade, vous êtes prêt à commencer à coder. Si c'est quelque chose de nouveau pour vous, engager un développeur pour vous aider est une bonne idée. Cependant, si vous voulez vous lancer vous-même, vous pouvez utiliser un « client API » tel que Postman ou Insomnia pour faire le gros du travail :

L'outil Postier.

Pour un aperçu concret de l'utilisation de l'API WooCommerce, vous pouvez consulter les blogs de développeurs sur le sujet. Par exemple, James Kemp chez IconicWP offre des informations utiles sur la façon dont une application Web PHP et des poignées de code peuvent se connecter à un magasin de commerce électronique et traiter ses données.

Conclusion

Lorsqu'il s'agit de choisir une plate-forme conviviale pour les utilisateurs et les développeurs, WordPress est sans doute le numéro un. De plus, WooCommerce est tout aussi convivial pour les propriétaires de magasins qui recherchent la simplicité, la puissance et la flexibilité. Une partie de ce qui le rend si adaptable est l'API REST WooCommerce. Bien qu'il s'agissait autrefois d'une entité distincte, elle a maintenant été fusionnée dans l'API REST WordPress principale.

Cet article a examiné l'API WooCommerce et vous a donné un aperçu de ce que vous pouvez en faire. Vous voudrez avoir une solide compréhension des concepts de base impliqués, ou vous pouvez envisager d'embaucher un développeur pour implémenter les fonctionnalités que vous souhaitez. Dans tous les cas, la puissance offerte par cette API peut avoir un impact direct et positif sur votre magasin et vos revenus.

Envisagez-vous d'utiliser l'API WooCommerce pour votre boutique, et si oui, qu'est-ce qui vous excite le plus ? Faites-nous savoir dans la section commentaires ci-dessous!

Crédit de l'image en vedette: monkographic / shutterstock.com