API
Cette page présente l'API de l'intégration Hiboutik. Pour configurer la connexion, voir Hiboutik.
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 de l'intégration
Les types de document exposés sont :
- Hiboutik Settings : les paramètres de connexion (document unique) ;
- Hiboutik Sales : une vente reçue de Hiboutik, avec son statut
Pending,CompletedouError; - Hiboutik Till Movement : un mouvement de caisse ;
- Hiboutik API Log : le journal des appels à l'API Hiboutik.
Les modes de paiement et les taux de TVA sont des tables enfants des paramètres.
Hiboutik envoie ses webhooks aux méthodes hiboutik.webhooks.pos_invoice_webhook (ventes) et hiboutik.webhooks.pos_customer_webhook (clients), sans clé d'API.
Dokos ne fait pas confiance au contenu reçu : il relit la vente dans l'API Hiboutik avant de l'enregistrer.
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 ventes Hiboutik en erreur :
curl -G "https://mappemonde.example.com/api/resource/Hiboutik Sales" \
-H "Authorization: token 1a2b3c4d5e6f7a8:9f8e7d6c5b4a3f2" \
--data-urlencode 'fields=["name", "hiboutik_unique_sales_id", "status", "error"]' \
--data-urlencode 'filters=[["status", "=", "Error"]]'