Saltar a contenido

SMSBAT ChatHub API

ChatHub REST API gestiona los chats comerciales de Viber, las conversaciones con los clientes y los flujos de trabajo de automatización de atención al cliente.

URL base

https://chatapi.smsbat.com

Documentación de arrogancia

La documentación API interactiva está disponible en:

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

Autenticación

ChatHub utiliza un sistema de autenticación basado en tokens de portador con tokens JWT. Los tokens se pueden pasar de dos maneras:

Método 1: encabezado de autorización

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

Método 2: encabezado de clave de autorización X

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

Flujo de autenticación

ChatHub utiliza un sistema de tokens de dos niveles:

  1. Token de empresa: token de acceso a nivel de organización
  2. Token de operador: token de acceso de operador individual

Flujo de trabajo

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

Puntos finales principales

Método Punto final Descripción
PUBLICAR /api/empresa/get-token Obtener token de autorización de la empresa
OBTENER /api/empresa/organización Recuperar lista de organizaciones
OBTENER /api/operador Listar operadores por organización
PUBLICAR /api/operador/sincronizar Agregar nuevos operadores
PUBLICAR /api/operador/estado Cambiar estado de operador
PUBLICAR /api/operador/get-token Generar tokens de operador (vencimiento máximo de 24 horas)
PUBLICAR /api/operador/validar-token Verificar la validez del token

Características clave

Gestión de tokens de empresa

Obtenga y administre tokens a nivel de organización para el acceso a API.

Gestión de la organización

  • Listar todas las organizaciones
  • Recuperar detalles de la organización
  • Administrar la configuración de la organización

Gestión de operadores

  • Listar operadores por organización.
  • Agregar nuevos operadores
  • Cambiar el estado del operador (Activo/Inactivo/Eliminado)
  • Generar tokens específicos del operador (máximo 24 horas)
  • Validar tokens de operador.

Integración de widgets

Integre el widget ChatHub en aplicaciones web para brindar atención al cliente en tiempo real.

Inicio rápido

  1. Autenticación - Obtenga sus tokens de empresa y operador
  2. Organizaciones - Administrar organizaciones
  3. Operadores - Agregar y administrar operadores
  4. Integración de widgets: integrar el widget de chat

Formato de solicitud

Todas las solicitudes utilizan el formato JSON:

{
  "login": "your-login",
  "password": "your-password"
}

Formato de respuesta

Vuelven las respuestas exitosas:

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

Manejo de errores

Códigos de estado HTTP:

  • 200 OK - Solicitud exitosa
  • 400 Solicitud incorrecta - Formato de solicitud no válido
  • 401 No autorizado - Error de autenticación
  • 403 Prohibido - Permisos insuficientes
  • 404 no encontrado - Recurso no encontrado
  • 500 Error interno del servidor - Error del servidor

Vencimiento del token

Los tokens tienen un tiempo de vencimiento. Cuando un token caduca:

  1. La API devolverá "401 no autorizado"
  2. Solicite un nuevo token utilizando el punto final de autenticación.
  3. Actualice su aplicación con el nuevo token

Próximos pasos