Authentifizierung
Jeder API-Aufruf trägt einen geheimen Schlüssel sw_live_, erstellt unter Einstellungen › Integrationen und nur einmal angezeigt. 120 Anfragen pro Minute und Schlüssel.
Einen Schlüssel erstellen
- Öffnen Sie Einstellungen › Integrationen in Ihrem StampyWallet-Bereich (als Inhaber oder Manager).
- Erstellen Sie einen Schlüssel und geben Sie ihm einen Namen, der sagt, wofür er dient („Kasse an der Theke“, „Website“).
- Kopieren Sie ihn sofort. Er beginnt mit
sw_live_und wird nur ein einziges Mal vollständig angezeigt: StampyWallet speichert nur einen Hash davon. Geht er verloren, lässt er sich nicht wiederherstellen: Widerrufen Sie ihn und erstellen Sie einen neuen.
Bei jedem Aufruf mitsenden
Der Schlüssel steht im Header Authorization, nach dem Wort Bearer:
Authorization: Bearer sw_live_4f9c2a7e1b...Ein Schlüssel gibt Zugriff auf ein Geschäft: das, in dem er erstellt wurde. Wenn Sie mehrere Filialen führen, erstellen Sie in jeder einen Schlüssel.
Achtung : der Schlüssel handelt in Ihrem Namen: Er legt Kunden an und erfasst Besuche. Bewahren Sie ihn auf dem Server auf (Umgebungsvariable, Secret-Speicher), niemals im Code einer Webseite oder einer mobilen App, niemals in einem Git-Repository.
Einen Schlüssel widerrufen
Widerrufen Sie den Schlüssel unter Einstellungen › Integrationen: Aufrufe mit diesem Schlüssel schlagen sofort mit 401 und dem Code cle_revoquee fehl. Tun Sie das, sobald ein Schlüssel nach außen gelangt sein könnte oder ein Dienstleister ihn nicht mehr braucht.
Zugriffsfehler
| Status | code | Wann |
|---|---|---|
401 | non_authentifie | Header fehlt oder Schlüssel unbekannt |
401 | cle_revoquee | Der Schlüssel wurde widerrufen |
403 | formule_requise | Das Geschäft hat nicht den Tarif Wachstum (die API ist darin enthalten und während der Testphase freigeschaltet) |
403 | interdit | Die Aktion ist für dieses Geschäft nicht erlaubt |
429 | trop_de_requetes | Mehr als 120 Anfragen pro Minute mit diesem Schlüssel |
Das Ratenlimit
120 Anfragen pro Minute und Schlüssel. Darüber hinaus lautet die Antwort 429 mit dem Header Retry-After: 60: Warten Sie diese Anzahl Sekunden, bevor Sie weitermachen. Eine normale Kasse ist weit davon entfernt.
Alle Details zum Fehlerformat finden Sie auf der Seite Fehler.