Open-API-Übersicht
Authentifizierung, Antwortformat, Fehlercodes und unterstützte Sprachcodes.
Im Folgenden steht {API} für die Service-Adresse. Du findest sie im Admin-Bereich auf der Seite „Integration".
Alle Anfragen tragen Authorization: Bearer sk_live_... (erstellt im Admin-Bereich auf der Seite „Integration", wird nur einmal angezeigt und gehört ausschließlich auf den Server).
Antworten haben einheitlich die Form {"code": "SUCCESS", "message": "", "data": ...}. Im Fehlerfall ist code ein stabiler Fehlercode – richte dich danach; message ist nur für Menschen gedacht. Geldbeträge sind immer Strings.
Fehlercodes
| code | Szenario |
|---|---|
UNAUTHORIZED | API Key ist ungültig oder wurde widerrufen |
VALIDATION_ERROR | Parameter sind nicht korrekt; data enthält das betroffene Feld |
NOT_FOUND | Ressource existiert nicht (auch Ressourcen, die nicht dir gehören) |
PLAN_LIMIT_REACHED | Produktanzahl, Wissensdatenbank-Kontingent oder Anzahl der Sitze deines Tarifs überschritten |
CONVERSATION_CLOSED | Die Konversation ist beendet, bitte eine neue starten |
CONVERSATION_OPEN | Die Konversation ist noch nicht beendet und kann nicht bewertet werden |
RATE_LIMITED | Zu viele Anfragen |
USER_TOKEN_INVALID | user_token-Signatur ist falsch oder abgelaufen |
CHECKOUT_FAILED | Die Bestellbestätigung ist abgelaufen oder die Bestell-API ist vorübergehend nicht erreichbar (wenn im Widget auf „Bestellung bestätigen" geklickt wird) |
ORIGIN_NOT_ALLOWED | Die aktuelle Website steht nicht auf der Liste der erlaubten Einbettungsziele |
LANGUAGE_NOT_SUPPORTED | Diese Sprache wird nicht unterstützt oder ist nicht freigeschaltet |
CHANNEL_CHECK_FAILED | AppID / AppSecret des Kanals lassen sich nicht verifizieren; message enthält den von WeChat zurückgegebenen Grund |
CHANNEL_REMOVED | Der Kanal, aus dem die Konversation stammt, wurde gelöscht – Antworten können nicht zugestellt werden |
Unterstützte Sprachcodes: zh-CN, zh-TW, en, ja, ko, de, fr, es, pt, it, ru, ar, th, vi, id, ms, tr, nl, pl. Schreibweisen wie zh-Hant, pt-BR oder en_US werden automatisch in den entsprechenden Code umgewandelt.
War diese Seite hilfreich?
Zuletzt aktualisiert:
