API-ключи
Создание и управление API-ключами в личном кабинете
API-ключи
Коротко: API-ключ — это ваш пропуск для интеграции. Создаётся в разделе «API Подключения» личного кабинета за 1 минуту.
Кому подходит
- Роль: Разработчик, Клиент
- Уровень: Новичок
Как создать ключ
Шаг 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: ваш-ключ
Управление ключом
| Действие | Что делает |
|---|---|
| Просмотр | Показывает название, права, вебхук |
| Редактирование | Изменяет права, вебхук, имена отправителей |
| Удаление | Отзывает ключ — все запросы с ним перестанут работать |
Совет: создавайте отдельный ключ для каждого окружения (тест, продакшн) и для каждого приложения.
Частые проблемы
| Симптом | Причина | Решение |
|---|---|---|
| Ключ не показывается | Уже создан, но потерян | Создайте новый, удалите старый |
| 401 Unauthorized | Неверный ключ | Проверьте X-API-Key |
| 403 Forbidden | Нет нужного права | Отредактируйте ключ, добавьте право |
| Вебхук не работает | Неверный URL | Проверьте доступность URL |
См. также
Нужна помощь?
- OTP-коды: support@otpcod.ru
- Multi API: support@multiapi.ru
- Мой диалог: support@mydialogi.ru