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

Посібник з інтеграції мобільного додатку

API використовує автентифікацію через Bearer-токен. Існує два типи API-ключів: API-ключ користувача (без Android-пристрою) та токен на пристрій (прив'язаний до зареєстрованого Android-телефону).

Типи токенів

Оберіть тип токена, що відповідає вашій інтеграції безкоштовного SMS-маркетингу:

API-ключ користувача - для прямого доступу до API (без телефону)

Пристрій не потрібен

Найпростіший спосіб інтеграції. Згенеруйте особистий API-ключ на сторінці Налаштування веб-панелі та використовуйте його для постановки SMS, WhatsApp-повідомлень і кампаній у чергу через будь-який HTTP-клієнт.

  1. Увійдіть у веб-панель та перейдіть до Налаштування.
  2. Прокрутіть до розділу API-ключ та натисніть Згенерувати ключ.
  3. Скопіюйте ключ та використовуйте його в заголовку Authorization: Bearer ваших запитів.
*
Ви можете перегенерувати ключ будь-коли в Налаштування > API-ключ. Старий ключ негайно анулюється.

Токен на пристрій - для Android-додатку

Потрібен Android-пристрій

Кожен Android-телефон, зареєстрований у розділі Пристрої, отримує власний токен. Цей токен використовується Android-додатком для отримання черги повідомлень, звітування про статус доставки та синхронізації вхідних.

  1. Перейдіть до Пристрої > Додати пристрій у веб-панелі.
  2. Відскануйте QR-код за допомогою Android-додатку. Додаток викликає claim_device і токен зберігається автоматично.
  3. Додаток використовує Authorization: Bearer {token} для всіх наступних запитів.

Надсилання токена

Заголовок Authorization (рекомендовано)

HTTP
Authorization: Bearer YOUR-API-KEY

Заголовок X-API-Token

HTTP
X-API-Token: YOUR-API-KEY

Параметр запиту ?token= (резервний варіант коли заголовки блокуються проксі)

URL
https://api.rcszilla.com/?endpoint=queue_sms&token=YOUR-API-KEY
*
Токени зберігаються та порівнюються у верхньому регістрі. API автоматично нормалізує ваш токен.

Застарілий токен

Старіші версії використовували єдиний спільний mobile_app_token на користувача, що зберігався в налаштуваннях. Це ще працює для зворотної сумісності, але API-ключ користувача або токени на пристрій є настійно рекомендованими.

*
Примітка щодо міграції: Якщо ваш додаток було створено до підтримки кількох пристроїв, він може використовувати застарілий токен. Для міграції відкрийте сторінку Пристрої у веб-панелі, згенеруйте токен на пристрій та оновіть конфігурацію додатку.

Життєвий цикл токена пристрою

  1. Адміністратор відкриває Пристрої > Додати пристрій у веб-панелі та генерується одноразовий токен реєстрації (QR-код).
  2. Додаток сканує QR і викликає claim_device з цим токеном.
  3. Сервер створює запис пристрою. Той самий токен тепер стає постійним API-токеном на пристрій.
  4. Додаток зберігає токен безпечно (рекомендується Android EncryptedSharedPreferences).
  5. Усі наступні запити використовують Authorization: Bearer {token}.
  6. Адміністратор може перегенерувати токен будь-коли зі сторінки Пристрої. Старий токен негайно анулюється.