Authentification
Chaque appel à l'API porte une clé secrète sw_live_, créée dans Réglages › Intégrations et montrée une seule fois. 120 requêtes par minute et par clé.
Créer une clé
- Ouvrez Réglages › Intégrations dans votre espace StampyWallet (le propriétaire ou un responsable).
- Créez une clé et donnez-lui un nom qui dit où elle sert (« Caisse du comptoir », « Site »).
- Copiez-la tout de suite. Elle commence par
sw_live_et n'est montrée entière qu'une seule fois : StampyWallet n'en garde qu'une empreinte. Perdue, elle ne se retrouve pas : révoquez-la et créez-en une autre.
L'envoyer à chaque appel
La clé part dans l'en-tête Authorization, après le mot Bearer :
Authorization: Bearer sw_live_4f9c2a7e1b...Une clé donne accès à un commerce : celui dans lequel elle a été créée. Si vous gérez plusieurs établissements, créez une clé dans chacun.
Attention : la clé agit en votre nom : elle crée des clients et ajoute des passages. Gardez-la côté serveur (variable d'environnement, coffre de secrets), jamais dans le code d'une page web ou d'une application mobile, jamais dans un dépôt Git.
Révoquer une clé
Dans Réglages › Intégrations, révoquez la clé : les appels qui la portent échouent aussitôt avec 401 et le code cle_revoquee. Faites-le dès qu'une clé a pu fuiter, ou quand un prestataire n'en a plus besoin.
Les erreurs d'accès
| Statut | code | Quand |
|---|---|---|
401 | non_authentifie | En-tête absent ou clé inconnue |
401 | cle_revoquee | La clé a été révoquée |
403 | formule_requise | Le commerce n'a pas la formule Croissance (l'API y est comprise, et ouverte pendant l'essai) |
403 | interdit | L'action n'est pas permise pour ce commerce |
429 | trop_de_requetes | Plus de 120 requêtes par minute avec cette clé |
La limite de débit
120 requêtes par minute et par clé. Au-delà, la réponse est 429 avec l'en-tête Retry-After: 60 : attendez ce nombre de secondes avant de reprendre. Une caisse ordinaire en est très loin.
Le détail du format des erreurs est sur la page Erreurs.
Mis à jour le