WooCommerce

API

Points d'accès de l'API du connecteur WooCommerce : commandes reçues, paramètres et webhooks.

Cette page présente l'API du connecteur WooCommerce. Pour connecter un site WooCommerce, voir Paramètres WooCommerce.

Familles de points d'accès

L'API de l'application a deux familles de points d'accès :

  • /api/resource/<Type de document> : lister, créer, lire, modifier et supprimer les documents d'un type. Les tables enfants n'ont pas de point d'accès propre : elles sont lues et écrites avec leur document parent.
  • /api/method/<chemin.de.la.méthode> : appeler une méthode Python ouverte à l'API (décorée par @frappe.whitelist).

Types de document et méthodes du connecteur

Les types de document exposés sont Woocommerce Settings (un document par site WooCommerce) et Woocommerce Order (une commande reçue de WooCommerce). Le statut d'une commande reçue est Pending, Order Created, Order Updated, Error ou Closed. Les taxes, les méthodes et statuts de livraison, les métadonnées et les correspondances de rôles sont des tables enfants.

WooCommerce envoie ses webhooks à la méthode dokos_woocommerce.woocommerce_connection.webhooks. Cette méthode n'utilise pas de clé d'API. Elle enregistre chaque webhook reçu dans une Integration Request, puis le traite en arrière-plan. Un même webhook (même site, même sujet, même identifiant) reçu deux fois en moins de 30 secondes n'est enregistré qu'une fois.

S'authentifier

Chaque appel s'authentifie avec les clés d'API d'un utilisateur, dans l'en-tête Authorization: token <api_key>:<api_secret>. L'API applique les droits de cet utilisateur. Pour générer les clés et connaître les principes de l'API, voir API Rest et API REST v2.

Exemple fictif

Un outil de suivi lit les commandes WooCommerce en erreur :

curl -G "https://mappemonde.example.com/api/resource/Woocommerce Order" \
  -H "Authorization: token 1a2b3c4d5e6f7a8:9f8e7d6c5b4a3f2" \
  --data-urlencode 'fields=["name", "woocommerce_id", "status"]' \
  --data-urlencode 'filters=[["status", "=", "Error"]]'