Перейти до змісту

SMSBAT ChatHub API

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

Базовий URL

https://chatapi.smsbat.com

Документація Swagger

Інтерактивна документація до API доступна за посиланням:

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

Авторизація

ChatHub використовує систему авторизації на основі Bearer-токенів (JWT). Токени можна передавати двома способами:

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

curl -X GET https://chatapi.smsbat.com/api/company/organization \
  -H "Authorization: Bearer ваш-jwt-токен"

Метод 2: Заголовок X-Authorization-Key

curl -X GET https://chatapi.smsbat.com/api/company/organization \
  -H "X-Authorization-Key: ваш-jwt-токен"

Процес Авторизації

ChatHub використовує дворівневу систему токенів:

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

Робочий процес

graph LR
    A[Отримати Токен Компанії] --> B[Список Організацій]
    B --> C[Список/Додавання Операторів]
    C --> D[Отримати Токен Оператора]
    D --> E[Інтеграція Віджета]

Основні Ендпоінти

Метод Ендпоінт Опис
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 Перевірити валідність токена

Основні Можливості

Управління Токенами Компанії

Отримуйте та керуйте токенами доступу рівня компанії для роботи з API.

Управління Організаціями

  • Перегляд списку всіх організацій
  • Отримання деталей окремої організації
  • Налаштування організацій

Управління Операторами

  • Перегляд списку операторів в межах організації
  • Додавання нових операторів
  • Зміна статусу (Активний/Неактивний/Видалений)
  • Генерація специфічних для оператора токенів (максимум на 24 години)
  • Валідація токенів оператора

Інтеграція Віджета

Інтегруйте віджет ChatHub у ваші веб-застосунки для забезпечення клієнтської підтримки в режимі реального часу.

Швидкий Старт

  1. Авторизація - Отримайте токени компанії та оператора
  2. Організації - Керування організаціями
  3. Оператори - Додавання та управління операторами
  4. Інтеграція віджета - Інтеграція чат-віджета

Формат Запитів

Усі запити використовують формат JSON:

{
  "login": "ваш-логін",
  "password": "ваш-пароль"
}

Формат Відповіді

Успішні запити повертають:

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

Обробка помилок (HTTP Статуси)

Коди стану HTTP:

  • 200 OK - Запит успішний
  • 400 Bad Request - Некоректний формат запиту
  • 401 Unauthorized - Помилка авторизації (неприпустимий токен)
  • 403 Forbidden - Недостатньо прав
  • 404 Not Found - Ресурс не знайдено
  • 500 Internal Server Error - Внутрішня помилка сервера

Час Життя Токена

Токени мають обмежений час дії (expiration time). Коли термін дії вичерпується:

  1. API поверне помилку 401 Unauthorized
  2. Запросіть новий токен за допомогою ендпоінта авторизації
  3. Оновіть токен у вашому додатку

Наступні Кроки