Словарь одной заявки · факты сверены 18.09.2026

Чем REST API отличается от webhook, OpenAPI и API MAX

REST API — ваша система спрашивает AppsMax. Webhook — AppsMax сам сообщает о событии. OpenAPI описывает методы, а API MAX принадлежит мессенджеру.

Разобрать на заявке ↓Уже есть аккаунт? Открыть подключения →

Начинайте с нужного действия в AppsMax: готовый путь передачи заявки может обойтись без отдельного REST-ключа.

ЧЕТЫРЕ ЗАПИСИ ОДНОГО ДЕЛАЗАЯВКА № · УЧЕБНЫЙ ПРИМЕР

ВАША СИСТЕМАспрашиваетREST API → AppsMax

APPSMAXсообщаетwebhook → получатель

OpenAPIописание правил

API MAXдругой сервис и токен

Смысловая схема, не интерфейс кабинета и не данные клиента.

Главное различие — кто начинает обмен. REST API: ваша программа обращается к AppsMax за данными или действием. Исходящий webhook: AppsMax сам отправляет вашей системе сообщение о событии. OpenAPI только описывает REST API, а официальный API MAX относится к самому мессенджеру и его боту.

Если вы просто хотите передать новую заявку в CRM, начните с раздела «API и интеграции» AppsMax. Там есть готовые пути без самостоятельного вызова API MAX.

01 · Один пример

Новая заявка помогает увидеть разницу

Клиент оставил заявку через подключённую форму. Если внешняя система должна узнать об этом сразу, AppsMax может отправить ей событие application.created по исходящему webhook. Получатель принимает HTTPS-запрос, проверяет его и обрабатывает заявку.

Если программа сама хочет получить список заявок или прочитать актуальную запись, она обращается к REST API AppsMax: например, GET /applications. Для такого запроса нужен отдельный ключ AppsMax с подходящим правом. Запрос чтения не запускает рассылку и не меняет заявку.

Webhook — сообщение от AppsMax во внешнюю систему. REST API — запрос вашей системы к AppsMax. В обоих случаях настройка и проверка выполняются в конкретной организации.

02 · Четыре понятия

Что делает каждый инструмент

01REST API AppsMax: Набор адресов и правил для запросов к данным платформы. Инициатор — ваша внешняя система; отдельный ключ разрешает только выданные действия. Начать с GET /me →
02Исходящий webhook AppsMax: Платформа сама посылает HTTPS-событие на адрес получателя, например о новой заявке. Получатель должен подтвердить приём и допускать повтор. Настроить получателя →
03OpenAPI: Файл с точным описанием методов REST API, полей, прав и ответов. Сам он не выполняет запросы и не отправляет события. Открыть текущий файл →
04Официальный API MAX: Отдельные методы мессенджера для собственного бота. Токен бота MAX не заменяет ключ REST API AppsMax; правила и адреса также различаются. Технический первоисточник MAX нужен самостоятельному разработчику.

03 · Вместе

Webhook и REST API можно сочетать

Webhook уже содержит данные события. Если обработчику после уведомления нужна самая свежая версия заявки, он может дополнительно запросить её через REST API — с отдельным ключом и только нужным правом. Это дополнительный шаг, а не обязательное условие каждого webhook.

Исходящая доставка AppsMax допускает повтор: по опубликованному контракту для временных ошибок предусмотрено до пяти попыток. Повтор не должен создавать вторую заявку или второе действие у получателя. После исчерпания попыток или постоянной ошибки доставка может остаться неуспешной; проверяйте журнал, а не считайте событие гарантированно полученным.

Секрет подписи webhook и ключ REST API храните отдельно. Не помещайте их в ссылку, браузерный код, снимок экрана, чат или общий документ. Памятка по безопасности →

04 · Граница MAX

Когда нужен официальный API MAX

Если клиент работает через AppsMax, начните в кабинете AppsMax: подключите своего бота MAX и выберите готовый сценарий или интеграцию. Прямой API MAX нужен разработчику, когда он сознательно пишет собственное взаимодействие с мессенджером вне возможностей публичного контракта AppsMax. Это другая ответственность и другой токен.

На дату факт-сверки официальный API MAX использует отдельный сервер и заголовок авторизации; ссылка на его документацию оставлена выше как технический первоисточник, а не как первый шаг клиентской настройки. Не подставляйте токен MAX в GET /api/v1/me AppsMax: этот адрес проверяет ключ платформы.

05 · Выбор

Какой следующий шаг подходит вам

Новая заявка должна попасть в CRM. Сначала проверьте готовый путь Битрикс24 или выбранный рецепт в кабинете; REST-ключ может не понадобиться.
Своя система должна читать или менять данные AppsMax. Выдайте отдельный ключ с нужными правами и выполните первый безопасный запрос на чтение.
Нужны уведомления о событиях заявки. Подготовьте HTTPS-получатель и настройте исходящий webhook.

REST API и исходящие webhook по текущим условиям доступны начиная с «Автоматизации» за 1 000 ₽ в месяц; сверьте тариф перед оплатой. Индивидуальные работы по внедрению оцениваются отдельно.