Visão geral da API aberta
Métodos de autenticação, formato de resposta, códigos de erro e códigos de idioma suportados.
O {API} abaixo refere-se ao endereço do serviço, que pode ser consultado na página «Integração» do painel.
Todas as requisições devem incluir Authorization: Bearer sk_live_... (criado na página «Integração» do painel, apresentado apenas uma vez e guardado apenas no servidor).
As respostas seguem sempre o formato {"code": "SUCCESS", "message": "", "data": ...}. Em caso de falha, code é um código de erro estável, que deve ser usado para tomar decisões; message destina-se apenas a leitura humana. Os valores monetários são sempre strings.
Códigos de erro
| code | Situação |
|---|---|
UNAUTHORIZED | API Key inválida ou revogada |
VALIDATION_ERROR | Parâmetros incorretos; data indica os campos concretos |
NOT_FOUND | Recurso inexistente (incluindo recursos que não lhe pertencem) |
PLAN_LIMIT_REACHED | Limite do plano excedido: número de produtos, capacidade da base de conhecimento ou número de agentes |
CONVERSATION_CLOSED | A conversa terminou; crie uma nova |
CONVERSATION_OPEN | A conversa ainda não terminou; não é possível avaliar |
RATE_LIMITED | Demasiadas requisições |
USER_TOKEN_INVALID | Assinatura de user_token incorreta ou expirada |
CHECKOUT_FAILED | A confirmação da encomenda expirou ou a API de criação de encomendas está temporariamente indisponível (quando o widget clica em «Confirmar encomenda») |
ORIGIN_NOT_ALLOWED | O site atual não está na lista de sites autorizados a incorporar |
LANGUAGE_NOT_SUPPORTED | Idioma não suportado ou não disponível |
CHANNEL_CHECK_FAILED | A validação do AppID / AppSecret do canal falhou; message contém o motivo devolvido pelo WeChat |
CHANNEL_REMOVED | O canal de origem da conversa foi eliminado; não é possível enviar a resposta |
Códigos de idioma suportados: zh-CN, zh-TW, en, ja, ko, de, fr, es, pt, it, ru, ar, th, vi, id, ms, tr, nl, pl. Formatos como zh-Hant, pt-BR e en_US são convertidos automaticamente para o código correspondente.
Esta página foi útil?
Última atualização:
