Обзор открытого API
Способы аутентификации, формат ответов, коды ошибок и поддерживаемые языковые коды.
В тексте ниже {API} обозначает адрес сервиса; его можно увидеть на странице «接入» (Подключение) в панели управления.
Все запросы должны содержать Authorization: Bearer sk_live_... (ключ создаётся на странице «接入» (Подключение) в панели управления, показывается только один раз и должен храниться только на сервере).
Ответ всегда имеет вид {"code": "SUCCESS", "message": "", "data": ...}. При ошибке code — это стабильный код ошибки, ориентируйтесь на него; message предназначен только для человека. Суммы всегда передаются строками.
Коды ошибок
| code | Когда возникает |
|---|---|
UNAUTHORIZED | API Key недействителен или отозван |
VALIDATION_ERROR | Неверные параметры; конкретные поля указаны в data |
NOT_FOUND | Ресурс не найден (в том числе ресурс, который вам не принадлежит) |
PLAN_LIMIT_REACHED | Превышен лимит тарифа на количество товаров, объём базы знаний или число операторов |
CONVERSATION_CLOSED | Диалог завершён, создайте новый |
CONVERSATION_OPEN | Диалог ещё не завершён, оценить его нельзя |
RATE_LIMITED | Слишком много запросов |
USER_TOKEN_INVALID | Неверная подпись user_token или срок его действия истёк |
CHECKOUT_FAILED | Подтверждение заказа больше недействительно или API оформления заказа временно недоступен (когда в виджете нажимают «Подтвердить заказ») |
ORIGIN_NOT_ALLOWED | Этого сайта нет в списке разрешённых для встраивания |
LANGUAGE_NOT_SUPPORTED | Этот язык не поддерживается или не включён |
CHANNEL_CHECK_FAILED | Проверка AppID / AppSecret канала не пройдена; причина, возвращённая WeChat, указана в message |
CHANNEL_REMOVED | Канал, из которого пришёл диалог, удалён — ответ отправить нельзя |
Поддерживаемые коды языков: zh-CN, zh-TW, en, ja, ko, de, fr, es, pt, it, ru, ar, th, vi, id, ms, tr, nl, pl. Такие варианты записи, как zh-Hant, pt-BR, en_US, автоматически заменяются на соответствующие коды.
Эта страница была полезной?
Обновлено:
