Ir para o conteúdo

API SMSBAT ChatHub

A API REST do ChatHub gerencia chats de negócios do Viber, conversas com clientes e fluxos de trabalho de automação de suporte ao cliente.

URL base

https://chatapi.smsbat.com

Documentação do Swagger

A documentação interativa da API está disponível em:

https://chatapi.smsbat.com/index.html

Autenticação

ChatHub usa um sistema de autenticação baseado em token Bearer com tokens JWT. Os tokens podem ser passados de duas maneiras:

Método 1: cabeçalho de autorização

curl -X GET https://chatapi.smsbat.com/api/company/organization \
  -H "Authorization: Bearer your-jwt-token"

Método 2: Cabeçalho X-Authorization-Key

CODE_BLOCO_3

Fluxo de autenticação

ChatHub usa um sistema de token de dois níveis:

  1. Token da Empresa – Token de acesso no nível da organização
  2. Token do Operador - Token de acesso individual do operador

Fluxo de trabalho

graph LR
    A[Get Company Token] --> B[List Organizations]
    B --> C[List/Add Operators]
    C --> D[Get Operator Token]
    D --> E[Integrate Widget]

Pontos finais principais

Método Ponto final Descrição
POSTAR /api/empresa/get-token Obtenha o token de autorização da empresa
OBTER /api/empresa/organização Recuperar lista de organizações
OBTER /api/operador Listar operadores por organização
POSTAR /api/operador/sincronizar Adicionar novos operadores
POSTAR /api/operador/status Alterar status do operador
POSTAR /api/operador/get-token Gerar tokens de operador (expiração máxima de 24h)
POSTAR /api/operador/validar-token Verifique a validade do token

Principais recursos

Gerenciamento de tokens da empresa

Obtenha e gerencie tokens no nível da organização para acesso à API.

Gestão da Organização

  • Listar todas as organizações
  • Recuperar detalhes da organização
  • Gerenciar configurações da organização

Gerenciamento de Operadores

  • Listar operadores por organização
  • Adicionar novos operadores
  • Alterar status do operador (Ativo/Inativo/Excluído)
  • Gere tokens específicos da operadora (máximo de 24 horas)
  • Validar tokens de operador

Integração de widgets

Integre o widget ChatHub em aplicativos da web para suporte ao cliente em tempo real.

Início rápido

  1. Autenticação - Obtenha tokens de sua empresa e operadora
  2. Organizações – Gerenciar organizações
  3. Operadores - Adicionar e gerenciar operadores
  4. Integração de widget - Integrar widget de chat

Formato de solicitação

Todas as solicitações usam o formato JSON:

CODE_BLOCO_5

Formato de resposta

Retorno de respostas bem-sucedidas:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiration": "2025-01-24T12:00:00Z"
}

Tratamento de erros

Códigos de status HTTP:

  • 200 OK - Solicitação bem-sucedida
  • 400 Bad Request - Formato de solicitação inválido
  • 401 Não Autorizado - Falha na autenticação
  • 403 Forbidden - Permissões insuficientes
  • 404 Not Found - Recurso não encontrado
  • 500 Erro interno do servidor - Erro do servidor

Expiração do token

Os tokens têm um prazo de validade. Quando um token expira:

  1. A API retornará 401 Unauthorized
  2. Solicite um novo token usando o endpoint de autenticação
  3. Atualize seu aplicativo com o novo token

Próximas etapas