Как создать API-ключ

Получение API-ключа для интеграции с Multi API — через раздел API Подключения

Как создать API-ключ

Коротко: API-ключ — ваш пропуск для интеграции с Multi API. Создаётся в личном кабинете за 1 минуту.

Кому подходит

  • Роль: Разработчик, Клиент
  • Уровень: Новичок

Что вы получите

API-ключ для отправки запросов в Multi API.

Перед началом

  • У вас есть доступ к личному кабинету Multi API.
  • Вы знаете, какие права нужны для вашей интеграции.

Шаги

Шаг 1. Откройте раздел «API Подключения»

В левом меню: API Подключения.

Шаг 2. Нажмите «Создать API подключение»

Кнопка в правом верхнем углу.

Шаг 3. Заполните форму

ПолеЧто указать
НазваниеПонятное имя, например «Тестовый ключ»
ВебхукURL, куда будут отправляться статусы (необязательно)
Права доступаВыберите нужные права

Шаг 4. Выберите права доступа

ПравоДля чего
omni-apiОтправка сообщений, проверка статусов
statisticsДоступ к статистике и EDR
recipientsУправление получателями
broadcastsУправление рассылками
didsУправление DID-номерами
crmИнтеграция с CRM

Шаг 5. Выберите имена отправителей

Укажите, для каких имён отправителей будет действовать этот ключ.

Шаг 6. Нажмите «Получить API ключ»

Шаг 7. Скопируйте ключ

Важно: ключ показывается только один раз. Сохраните его в надёжном месте.

Как использовать

Ключ передаётся в заголовке X-API-Key в каждом запросе.

Формат заголовка: X-API-Key: ваш-ключ

Результат

API-ключ создан. Вы можете использовать его для интеграции с Multi API.

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

ДействиеЧто делает
ПросмотрПоказывает название, права, вебхук
РедактированиеИзменяет права, вебхук, имена отправителей
УдалениеОтзывает ключ — все запросы с ним перестанут работать

Совет: создавайте отдельный ключ для каждого окружения (тест, продакшн) и для каждого приложения.

Частые проблемы

СимптомПричинаРешение
Ключ не показываетсяУже создан, но потерянСоздайте новый, удалите старый
401 UnauthorizedНеверный ключПроверьте X-API-Key
403 ForbiddenНет нужного праваОтредактируйте ключ, добавьте право
Вебхук не работаетНеверный URLПроверьте доступность URL

См. также

Нужна помощь?