Aperçu de l'API publique
Authentification, format des réponses, codes d'erreur et codes de langue pris en charge.
Dans la suite de ce document, {API} désigne l'adresse du service, visible dans la page « Intégration » du back-office.
Toutes les requêtes doivent inclure Authorization: Bearer sk_live_... (créé dans la page « Intégration » du back-office, affiché une seule fois, à conserver uniquement sur le serveur).
Les réponses ont toujours la forme {"code": "SUCCESS", "message": "", "data": ...}. En cas d'échec, code est un code d'erreur stable, à utiliser pour le traitement ; message est uniquement destiné à l'affichage. Les montants sont toujours des chaînes de caractères.
Codes d'erreur
| code | Cas |
|---|---|
UNAUTHORIZED | API Key invalide ou révoquée |
VALIDATION_ERROR | Paramètres incorrects ; data contient les champs concernés |
NOT_FOUND | Ressource inexistante (y compris les ressources qui ne vous appartiennent pas) |
PLAN_LIMIT_REACHED | Nombre de produits, capacité de la base de connaissances ou nombre de sièges du forfait dépassé |
CONVERSATION_CLOSED | La conversation est terminée, veuillez en créer une nouvelle |
CONVERSATION_OPEN | La conversation n'est pas encore terminée, impossible de l'évaluer |
RATE_LIMITED | Trop de requêtes |
USER_TOKEN_INVALID | La signature de user_token est incorrecte ou a expiré |
CHECKOUT_FAILED | La confirmation de commande a expiré, ou l'API de commande est temporairement indisponible (lors d'un clic sur « Confirmer la commande » dans le widget) |
ORIGIN_NOT_ALLOWED | Le site actuel ne figure pas dans la liste des sites autorisés à intégrer le widget |
LANGUAGE_NOT_SUPPORTED | Langue non prise en charge ou non activée |
CHANNEL_CHECK_FAILED | La validation de l'AppID / AppSecret du canal a échoué ; message contient la raison renvoyée par WeChat |
CHANNEL_REMOVED | Le canal d'où provient la conversation a été supprimé ; impossible d'envoyer la réponse |
Codes de langue pris en charge : zh-CN, zh-TW, en, ja, ko, de, fr, es, pt, it, ru, ar, th, vi, id, ms, tr, nl, pl. Les variantes comme zh-Hant, pt-BR ou en_US sont automatiquement remplacées par le code correspondant.
Cette page vous a-t-elle été utile ?
Dernière mise à jour:
