REST API v1 · связь серверов
Первый запрос — без лишних прав.
REST API — это способ для вашей серверной системы обращаться к данным 320apps. Начните с отдельного ключа и проверки /ping, а доступ расширяйте только по необходимости.
Ключ действует на всю организацию · полный секрет показывается один раз · REST API v1 / OpenAPI 1.1.1 сверены 16.09.2026
- Точка отправленияmy.320apps.ru
/api/v1 - ПропускBearer-ключ
- КонтрольнаяGET /ping
- Квитанция200 · X-Request-Id
Секрет в браузере —
уже не секрет
Сначала выберите направление
Запросить данные или дождаться события?
REST API
Внешняя система сама читает или изменяет разрешённые данные. Нужен ключ с точными правами.
Вы на этой страницеИсходящий webhook
320apps сообщает о выбранном событии. Нужен HTTPS-получатель; для проверки отправителя рекомендуем секрет подписи.
Перейти к webhook →Пять контрольных точек
Маршрут, который легко повторить
Каждая следующая точка появляется только после предыдущей. Так секрет не теряется, а чрезмерные права не становятся привычкой.
- 01
Определите один запрос
Например, получить список заявок. Для уведомления о новой заявке выберите webhook, а не опрос API.
- 02
Выдайте минимум прав
Отдельный ключ, понятное название и только нужные действия. Управляет ключом владелец организации.
- 03
Сохраните секрет один раз
Полное значение больше не показывается. Держите его в защищённых настройках серверной системы.
- 04
Проверьте
/pingОжидайте HTTP 200,
status: ok, версиюv1и свойX-Request-Idв ответе. - 05
Сделайте один безопасный GET
Проверьте форму ответа и только затем добавляйте права на изменение данных.
Текущий кабинет · 15.09.2026
Права видны до создания ключа
Ключ относится ко всей организации. Готовый набор «Только чтение» не меняет данные; при необходимости каждое право настраивается отдельно.
- По умолчанию
- 60 запросов в минуту
- Допустимый максимум
- 600 запросов в минуту
- Полный секрет
- показывается один раз
На снимке — настоящая форма тестового кабинета продукта. Секрет ещё не создан; интерфейс не дорисовывался.
Проверка без изменения данных
Один запрос. Один понятный ответ.
Замените YOUR_TOKEN полным ключом в защищённой среде. В адресе и параметрах запроса секрет не передаётся.
curl --request GET \
--url 'https://my.320apps.ru/api/v1/ping' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--header 'X-Request-Id: first-ping-001'HTTP/2 200
X-Api-Version: v1
X-Request-Id: first-ping-001
Cache-Control: no-store, private
{
"status": "ok",
"organization_id": 1001
}организация целиком
Ключ не наследует смысл из своего названия. Разрешают только выбранные машинные права.
Пропуск, а не мастер-ключ
Давайте интеграции ровно столько, сколько ей нужно
Для первого чтения не выбирайте «Все возможности». Начните с готового набора только для чтения или раскройте ручную настройку.
Посмотреть все 12 прав API
organizations:readОрганизация · чтениеbots:readПроекты · чтениеconnections:readПодключения · чтениеminiapps:readМини-приложения · чтениеfunnels:readСценарии · чтениеinteractive_menu:readМеню · чтениеapplications:readЗаявки · чтениеapplications:writeЗаявки · изменениеcampaigns:readРассылки · чтениеcampaigns:writeРассылки · изменениеsubscribers:readПодписчики · чтениеsubscribers:writeПодписчики · изменение
Точный контракт
OpenAPI и Postman строятся из одного источника
В кабинете можно скачать JSON-описание API или готовую коллекцию запросов. Текущий файл имеет версию 1.1.1 и описывает 21 метод.
- 01Аккаунт и организация
/ping,/me,/organizations - 02Проекты и подключениячтение доступного состава
- 03Заявкичтение, создание и метки
- 04Рассылки и подписчикираздельные права чтения и изменения
Для каждого метода проверьте необходимые права и обязательные поля в скачанной спецификации.
Если маршрут оборвался
Статус говорит, где искать причину
Ответы API имеют JSON-формат. Сначала прочитайте статус и код ошибки, сохраните X-Request-Id, затем исправляйте запрос.
| Статус | Что произошло | Что проверить |
|---|---|---|
| 400 | Неверный JSON | Синтаксис и кодировку тела |
| 401 | Ключ не принят | Bearer-заголовок и отзыв ключа |
| 403 | Недостаточно прав | Точное право для метода |
| 413 | Тело больше 256 КиБ | Размер отправляемых данных |
| 415 | Неверный тип тела | Content-Type: application/json |
| 422 | Данные не прошли проверку | Поля и Idempotency-Key |
| 429 | Слишком много запросов | Retry-After и частоту повторов |
Проверка и замена
Сначала новый ключ. Потом отзыв старого.
- 1Создайте новый ключ с минимальными правами.
- 2Замените его в серверной системе и выполните
/ping. - 3После успешного запроса отзовите старый ключ.
Проверка раньше отзыва —
маленькая полезная привычка
Короткие ответы
Перед первым рабочим запросом
REST API и webhook — это одно и то же?
Нет. Через REST API ваша серверная система сама запрашивает или изменяет разрешённые данные в 320apps. Webhook, наоборот, сам сообщает вашей системе о выбранном событии.
Можно вставить ключ API в JavaScript на сайте?
Нет. Посетитель сможет извлечь его из кода или сетевого запроса. Ключ хранится только на сервере или в защищённом хранилище внешней системы.
Почему ключ действует не на один проект?
Текущий ключ относится ко всей организации. Поэтому его создаёт владелец, а права нужно ограничить только теми разделами и действиями, которые действительно нужны интеграции.
Где взять точные схемы запросов и ответов?
Откройте «Документацию» в разделе API и интеграций. Там скачиваются OpenAPI JSON и коллекция Postman, собранные из одной текущей спецификации.
Что сохранить при ошибке?
Сохраните время запроса, HTTP-статус и X-Request-Id из ответа. Полный ключ и содержимое с персональными данными в письмо или обычный журнал добавлять не нужно.
Как заменить ключ без остановки интеграции?
Создайте новый ключ с теми же минимальными правами, замените его во внешней системе, выполните проверку и только после успешного ответа отзовите старый.
Маршрут готов
Создайте один ключ для одной понятной задачи
Проверьте /ping, скачайте текущую спецификацию и добавляйте права только по мере необходимости.