API
Cette page affiche la référence interactive de l'API de l'application Payments. Pour configurer les passerelles, voir Paiements en ligne.
Ce que contient la référence
La référence est générée par le site de démonstration à partir du code de l'application. Elle contient 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).
La référence est en lecture seule : les boutons Authorize et Try it out sont masqués. Utilisez le champ de filtre pour chercher un point d'accès.
Types de document et méthodes de Payments
Les types de document exposés sont Payment Gateway, Payment Session et les paramètres de chaque passerelle (par exemple Stripe Settings, GoCardless Settings, Stancer Settings, SumUp Settings).
La plupart des méthodes servent aux pages de paiement et aux webhooks des passerelles. Les passerelles appellent leurs webhooks sans clé d'API. Ne les appelez pas depuis vos propres intégrations.
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 passerelles de paiement configurées :
curl -G "https://mappemonde.example.com/api/resource/Payment Gateway" \
-H "Authorization: token 1a2b3c4d5e6f7a8:9f8e7d6c5b4a3f2" \
--data-urlencode 'fields=["name", "gateway_settings", "gateway_controller"]'