API-ключи
Создание и управление API-ключами — права доступа, имена отправителей, вебхук, использование в запросах
Коротко: API-ключ — это токен для аутентификации в API платформы. Он создаётся в разделе «API Подключения». Ключ передаётся в заголовке
X-API-Keyв каждом запросе.
Кому подходит
- Роль: Клиент, Администратор
- Уровень: Новичок
Что вы получите
API-ключ, с которым можно отправлять сообщения и управлять данными через API платформы.
Перед началом
- У вас есть доступ к разделу «API Подключения» в личном кабинете.
- Вы определили, какие права доступа нужны ключу (какие API будете использовать).
- У вас есть имена отправителей для тех каналов, через которые планируете работать. Имя отправителя должно быть со статусом Активно.
Шаги
В левом меню личного кабинета нажмите API Подключения.
Кнопка в правом верхнем углу страницы.
Название отображается в таблице. Под этим названием будет видна статистика по кодам отправки в отчётах.
URL, на который будут отправляться статусы и ответные сообщения. Подробнее — Вебхуки.
Выберите один или несколько scope. От них зависит, какие операции будут доступны ключу. Список — в таблице ниже.
Отметьте одно или несколько имён отправителей, от имени которых ключ сможет работать.
Имя отправителя привязано к конкретному каналу. Выбирая имя, вы открываете ключу доступ к каналу этого имени. Чтобы ключ мог отправлять по SMS и WhatsApp — выберите два имени: для SMS и для WhatsApp.
Ключ появится в окне. Скопируйте его — он понадобится для каждого запроса.
Нажмите Сохранить, чтобы закрыть окно и вернуться к таблице.
Какие каналы будут доступны ключу
Каналы не выбираются напрямую — они определяются выбранными именами отправителей. У каждого имени отправителя есть свой канал, и ключ получает доступ только к тем каналам, чьи имена вы отметили.
Пример:
| Выбранное имя отправителя | Канал | Что доступно через ключ |
|---|---|---|
MyBrand_SMS | SMS | Отправка SMS |
MyBrand_WA | Отправка WhatsApp | |
MyBrand_RCS | RCS | Отправка RCS |
Если вы выбрали три имени — ключ сможет отправлять по SMS, WhatsApp и RCS. Если одно — только по его каналу.
Права доступа
Права доступа (scope) определяют, какие операции доступны ключу.
| Scope | Что даёт |
|---|---|
| recipients | Работа с получателями |
| broadcasts | Работа с рассылками |
| CRM | Интеграция с CRM |
| omni-api | Отправка сообщений через OMNI API |
| dids | Работа с номерами |
| statistics | Просмотр статистики |
Права доступа и имена отправителей работают вместе. Права определяют, какие операции доступны ключу. Имена отправителей — по каким каналам эти операции можно выполнять.
Как использовать ключ
Ключ передаётся в заголовке X-API-Key в каждом запросе:
curl --location 'https://<домен-сервиса>/api/v1/messages' \
--header 'X-API-Key: <ваш-ключ>' \
--header 'Content-Type: application/json' \
--data-raw '{ ... }'Таблица API Подключения
| Колонка | Что показывает |
|---|---|
| ID | Идентификатор подключения в системе |
| Название | Название ключа |
| API ключ | Сам ключ |
| Права доступа | Назначенные scope |
| Вебхук | URL для статусов и ответов |
| Действия | Редактировать или удалить |
Управление ключами
В окне ключа доступны действия:
- Скопировать — копирует ключ в буфер обмена.
- Получить API ключ — генерирует новый ключ.
- Удалить — удаляет запись.
- Сохранить — сохраняет запись и закрывает окно.
- Отменить — сбрасывает настройки.
Результат
API-ключ создан. Его можно использовать в запросах к API платформы.
Частые проблемы
Причина: заголовок X-API-Key не передан, ключ неверный или от другого сервиса.
Решение: проверьте заголовок и скопируйте ключ заново. Подробнее — Ошибка 401.
Причина: у ключа нет нужного scope.
Решение: откройте ключ и добавьте нужный scope в правах доступа.
Причина: в запросе указано имя отправителя, которое не привязано к этому ключу.
Решение: откройте ключ и добавьте нужное имя отправителя в список.
Причина: нет прав на раздел «API Подключения».
Решение: обратитесь в поддержку вашего сервиса.
См. также
Нужна помощь?
- OTP-коды: support@otpcod.ru
- Multi API: support@multiapi.ru
- Мой диалог: support@mydialogi.ru