Аутентификация

Как это работает

Uvio Notify API использует схему аутентификации по API-ключу. Каждый ключ привязан к конкретной компании — сервер автоматически определяет вашу компанию по ключу, поэтому дополнительно передавать Company ID не нужно.

Добавьте заголовок X-API-Key к каждому HTTP-запросу:

curl -X GET https://api.uvio.chat/notify/v1/health \
  -H "X-API-Key: sk_live_your_secret_key"

Запросы без заголовка X-API-Key или с недействительным ключом получат ответ 401 Unauthorized.

Получение API-ключа

API-ключи создаются в Личном Кабинете компании. Для этого у вас должна быть одобренная регистрация компании. Если вы ещё не зарегистрировались, начните с раздела Начало работы.

Использование ключа

Передайте ключ в заголовке X-API-Key. Ниже приведены примеры на разных языках.

cURL

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

Python

import os
import requests

API_KEY = os.getenv("UVIO_API_KEY")
BASE_URL = "https://api.uvio.chat/notify/v1"

response = requests.post(
    f"{BASE_URL}/otps",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": API_KEY,
    },
    json={
        "identifier": "user@example.com",
        "identifier_type": "email",
    },
)

print(response.json())

JavaScript / Node.js

const API_KEY = process.env.UVIO_API_KEY;
const BASE_URL = "https://api.uvio.chat/notify/v1";

const response = await fetch(`${BASE_URL}/otps`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": API_KEY,
  },
  body: JSON.stringify({
    identifier: "user@example.com",
    identifier_type: "email",
  }),
});

const data = await response.json();
console.log(data);

Ошибки аутентификации

При проблемах с аутентификацией API возвращает один из следующих HTTP-статусов:

Пример ответа с ошибкой

{
  "error": "Unauthorized",
  "details": "Invalid API key"
}

Безопасность

API-ключ предоставляет полный доступ к операциям вашей компании. Обращайтесь с ним как с паролем.

Управление ключами

В Личном Кабинете вы можете создавать и отзывать ключи. Рекомендуем держать не более двух активных ключей одновременно — один основной и один резервный для ротации.

Ротация ключей

Процедура безопасной замены ключа без простоя:

Базовый URL и заголовки

Все запросы к Notify API отправляются на единый базовый адрес с обязательными заголовками.

Что дальше

Теперь, когда вы знаете как аутентифицировать запросы, изучите конкретные API: