Результат: вы сможете объяснить разработчику, откуда и куда должны идти данные.
Один пример
Представьте новую заявку клиента. Webhook — платформа сама сообщает: «появилась новая заявка». REST API — ваша система сама спрашивает платформу: «покажи заявку» или просит выполнить действие. OpenAPI — точная машиночитаемая инструкция к REST API. API MAX — отдельный официальный интерфейс самого мессенджера MAX.
| Понятие | Кто начинает | Пример |
|---|---|---|
| Webhook платформы | Платформа | Отправляет событие application.created |
| REST API платформы | Ваша система | Выполняет GET /applications |
| OpenAPI | Никто: это описание | Импортируется в Postman или генератор клиента |
| API MAX | Ваш код и MAX | Работа с официальными возможностями платформы MAX |
Когда полезен гибрид
Webhook быстро сообщает идентификатор изменившейся заявки. После этого обработчик делает REST-запрос и получает актуальное состояние. Получатель должен допускать повтор webhook: доставка работает по принципу «не менее одного раза».
Граница с API MAX
API платформы удобен для объектов кабинета: заявок, подписчиков, рассылок, ботов, подключений, мини-приложений, сценариев и меню. Прямой API MAX нужен, если платформа не участвует в процессе или требуется возможность мессенджера, которой нет в публичном контракте платформы. Токены этих систем не взаимозаменяемы.
Проверка понимания
- «платформа должна сразу сообщить о заявке» — webhook.
- «Наша CRM должна раз в минуту читать заявки» — REST API.
- «Нужно увидеть все поля метода» — OpenAPI.
- «Нужно напрямую вызвать функцию MAX» — официальный API MAX.
Дальше: обзор рабочего раздела API.
Если не хочется разбираться самостоятельно, мы можем помочь. Поможем настроить платформу под вашу задачу и быстрее запустить проект без лишних шагов.