Начало работы с Uvio Notify

Uvio Notify API предоставляет OTP-аутентификацию, push-уведомления, события и публикации в ленте. Зарегистрируйте компанию, получите API-ключ и сделайте первый запрос за несколько минут.

Полное описание всех эндпоинтов и параметров доступно в Справочнике API.

Обзор

Uvio Notify API позволяет вашему продукту отправлять OTP-запросы, push-уведомления, управлять событиями и публикациями в ленте. Базовый URL: https://api.uvio.chat/notify/v1. Аутентификация выполняется через заголовок X-API-Key.

Что понадобится

Перед началом работы

Убедитесь, что у вас есть:

  • Аккаунт в мобильном приложении Uvio. Скачайте приложение из App Store или RuStore и завершите регистрацию.
  • Рабочая электронная почта, совпадающая с вашим аккаунтом Uvio, а также ИНН компании (12 цифр) и адрес сайта.

Шаг 1. Зарегистрируйте компанию

Перейдите на страницу регистрации https://lk.uvio.chat/register и следуйте пошаговому мастеру.

1

Откройте Личный Кабинет

Перейдите по адресу https://lk.uvio.chat/register в браузере на компьютере.

2

Заполните данные компании

Укажите название компании, ИНН (12 цифр), адрес сайта и рабочую электронную почту, привязанную к вашему аккаунту Uvio.

3

Подтвердите OTP

Подтвердите шестизначный код, который придёт в мобильное приложение Uvio. Код действителен 10 минут.

Шаг 2. Войдите в Личный Кабинет

После регистрации войдите в Личный Кабинет по адресу https://lk.uvio.chat. Авторизация выполняется через OTP — пароль не требуется.

Процесс входа

1

Введите email

На странице входа укажите электронную почту, подтверждённую при регистрации.

2

Получите OTP

Код подтверждения будет отправлен в мобильное приложение Uvio на вашем телефоне.

3

Подтвердите и войдите

Введите OTP в течение 10 минут, чтобы получить доступ к панели управления компанией.

Шаг 3. Получите API-ключ

API-ключ используется для аутентификации запросов к Uvio Notify API. Ключ привязан к вашей компании и передаётся в заголовке X-API-Key.

Создание ключа в Личном Кабинете

  1. Войдите в Личный Кабинет (https://lk.uvio.chat)
  2. Перейдите в НастройкиAPI-ключи
  3. Нажмите Создать новый API-ключ
  4. Важно: скопируйте ключ сразу — он будет показан только один раз
Формат заголовка
X-API-Key: sk_live_...
Безопасность
  • Никогда не сохраняйте ключи в системе контроля версий
  • Храните ключи в переменных окружения или в менеджере секретов
  • Регулярно ротируйте ключи, а при подозрении на компрометацию — немедленно
  • Если ключ утерян — отзовите его и создайте новый

Шаг 4. Сделайте первый запрос

Отправим простейший запрос — создание OTP. Базовый URL API: https://api.uvio.chat/notify/v1.

cURL
curl -X POST https://api.uvio.chat/notify/v1/otps \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "identifier": "user@example.com",
    "identifier_type": "email"
  }'

Успешный ответ

200 OK
{
  "otp_id": "550e8400-e29b-41d4-a716-446655440000",
  "expires_at": "2024-01-01T12:10:00Z",
  "status": "sent"
}
Готово

Если вы получили ответ 200 OK с otp_id — интеграция работает. Пользователь получит OTP-код в приложении Uvio.

Что дальше

API-ключ получен, первый запрос выполнен. Изучите возможности Uvio Notify подробнее: