---
title: API-ключи
description: Создание и управление API-ключами — права доступа, имена отправителей, вебхук, использование в запросах
---

> **For AI agents:** the complete documentation index is at [llms.txt](https://docs.mydialogi.ru/llms.txt). Append `.md` to any page URL for its markdown version.


> **Коротко:** API-ключ — это токен для аутентификации в API платформы. Он создаётся в разделе «API Подключения». Ключ передаётся в заголовке `X-API-Key` в каждом запросе.

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

- Роль: Клиент, Администратор
- Уровень: Новичок

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

API-ключ, с которым можно отправлять сообщения и управлять данными через API платформы.

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

- [ ] У вас есть доступ к разделу «API Подключения» в личном кабинете.
- [ ] Вы определили, какие права доступа нужны ключу (какие API будете использовать).
- [ ] У вас есть **имена отправителей** для тех каналов, через которые планируете работать. Имя отправителя должно быть со статусом **Активно**.


## Шаги

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

В левом меню личного кабинета нажмите **API Подключения**.

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

Кнопка в правом верхнем углу страницы.

### 3. Введите название

Название отображается в таблице. Под этим названием будет видна статистика по кодам отправки в отчётах.

### 4. Укажите вебхук

URL, на который будут отправляться статусы и ответные сообщения. Подробнее — [Вебхуки](https://docs.mydialogi.ru/06-reference/01-api/api-webhooks).

### 5. Настройте права доступа

Выберите один или несколько scope. От них зависит, какие операции будут доступны ключу. Список — в таблице ниже.

### 6. Выберите имена отправителей

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

<Note>
Имя отправителя привязано к конкретному каналу. Выбирая имя, вы открываете ключу доступ к каналу этого имени. Чтобы ключ мог отправлять по SMS и WhatsApp — выберите два имени: для SMS и для WhatsApp.
</Note>

### 7. Нажмите Получить API ключ

Ключ появится в окне. Скопируйте его — он понадобится для каждого запроса.

### 8. Сохраните

Нажмите **Сохранить**, чтобы закрыть окно и вернуться к таблице.

## Какие каналы будут доступны ключу

Каналы не выбираются напрямую — они определяются выбранными **именами отправителей**. У каждого имени отправителя есть свой канал, и ключ получает доступ только к тем каналам, чьи имена вы отметили.

**Пример:**

| Выбранное имя отправителя | Канал | Что доступно через ключ |
|---|---|---|
| `MyBrand_SMS` | SMS | Отправка SMS |
| `MyBrand_WA` | WhatsApp | Отправка WhatsApp |
| `MyBrand_RCS` | RCS | Отправка RCS |

Если вы выбрали три имени — ключ сможет отправлять по SMS, WhatsApp и RCS. Если одно — только по его каналу.

## Права доступа

Права доступа (scope) определяют, какие операции доступны ключу.

| Scope | Что даёт |
|---|---|
| recipients | Работа с получателями |
| broadcasts | Работа с рассылками |
| CRM | Интеграция с CRM |
| omni-api | Отправка сообщений через OMNI API |
| dids | Работа с номерами |
| statistics | Просмотр статистики |

<Note>
Права доступа и имена отправителей работают вместе. Права определяют, **какие операции** доступны ключу. Имена отправителей — **по каким каналам** эти операции можно выполнять.
</Note>

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

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

```bash
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 платформы.

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

### 401 Unauthorized

**Причина:** заголовок `X-API-Key` не передан, ключ неверный или от другого сервиса.

**Решение:** проверьте заголовок и скопируйте ключ заново. Подробнее — [Ошибка 401](https://docs.mydialogi.ru/06-reference/03-troubleshooting/ts-mapi-401).

### 403 Forbidden

**Причина:** у ключа нет нужного scope.

**Решение:** откройте ключ и добавьте нужный scope в правах доступа.

### 400 Bad Request: sender not found

**Причина:** в запросе указано имя отправителя, которое не привязано к этому ключу.

**Решение:** откройте ключ и добавьте нужное имя отправителя в список.

### Создать API подключение недоступно

**Причина:** нет прав на раздел «API Подключения».

**Решение:** обратитесь в поддержку вашего сервиса.

## См. также

<Columns cols={2}>
  <Card title="Обзор API" icon="book" href="/06-reference/01-api/api-overview">
    Единое API платформы
  </Card>
  <Card title="Обработка ошибок API" icon="triangle-exclamation" href="/06-reference/01-api/api-errors">
    HTTP-коды и форматы ответов
  </Card>
  <Card title="Вебхуки" icon="link" href="/06-reference/01-api/api-webhooks">
    Статусы сообщений и рассылок
  </Card>
  <Card title="API Multi API" icon="plug" href="/03-multiapi/02-api/mapi-101-api-overview">
    Полное описание API Multi API
  </Card>
</Columns>

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

- OTP-коды: support@otpcod.ru
- Multi API: support@multiapi.ru
- Мой диалог: support@mydialogi.ru