Към съдържанието

SMSBAT ChatHub API

ChatHub REST API управлява бизнес чатове във Viber, разговори с клиенти и автоматизирани работни процеси за поддръжка на клиенти.

Базов URL адрес

https://chatapi.smsbat.com

Swagger документация

Интерактивната API документация е достъпна на:

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

Автентикация

ChatHub използва система за удостоверяване, базирана на Bearer токент с JWT. Токените могат да бъдат подавани по два начина:

Метод 1: Authorization Header (Заглавка)

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

Метод 2: X-Authorization-Key Header

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

Работен процес на автентикация

ChatHub използва система с токени на две нива:

  1. Company Token (Токен на компания) - Токен за достъп на ниво организация
  2. Operator Token (Токен на оператор) - Токен за достъп за индивидуален оператор

Работен процес (Workflow)

graph LR
    A[Вземете Company Token] --> B[Списък с организации]
    B --> C[Списък/Добавяне на оператори]
    C --> D[Вземете Operator Token]
    D --> E[Интегриране на Widget]

Основни крайни точки (Endpoints)

Метод Endpoint Описание
POST /api/company/get-token Получаване на токен за авторизация на компанията
GET /api/company/organization Извличане на списък с организации
GET /api/operator Списък с оператори по организация
POST /api/operator/synchronize Добавяне на нови оператори
POST /api/operator/status Промяна на статуса на оператор
POST /api/operator/get-token Генериране на токени за оператор (макс 24ч валидност)
POST /api/operator/validate-token Проверка валидността на токен

Основни характеристики

Управление на Company токени

Получавайте и управлявайте токени на ниво организация за достъп до API.

Управление на организации

  • Списък на всички организации
  • Извличане на детайли за организация
  • Управление на настройките на организация

Управление на оператори

  • Списък с оператори по организация
  • Добавяне на нови оператори
  • Промяна на статуса на оператор (Активен/Неактивен/Изтрит)
  • Генериране на специфични за оператора токени (максимум 24 часа)
  • Валидиране (проверка) на токени на оператор

Интеграция на Widget

Интегрирайте чат уиджет (приставка) на ChatHub в уеб приложения за поддръжка на клиенти в реално време.

Бърз старт

  1. Автентикация - Вземете своите токени за компания и оператор
  2. Организации - Управление на организации
  3. Оператори - Добавяне и управление на оператори
  4. Интеграция на Widget - Интегрирайте чат уиджета

Формат на заявката

Всички заявки използват JSON формат:

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

Формат на отговора

Успешните отговори връщат (return):

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

Обработка на грешки

HTTP кодове за статус:

  • 200 OK - Заявката е успешна
  • 400 Bad Request - Невалиден формат на заявката
  • 401 Unauthorized - Неуспешно удостоверяване (грешна парола или токен)
  • 403 Forbidden - Недостатъчни права за достъп
  • 404 Not Found - Ресурсът не е намерен
  • 500 Internal Server Error - Грешка в сървъра

Изтичане на токена

Токените имат време на валидност (изтичане). Когато даден токен изтече:

  1. API ще върне 401 Unauthorized
  2. Поискайте нов токен, използвайки крайната точка (endpoint) за удостоверяване
  3. Актуализирайте приложението си с новия токен

Следващи стъпки