Справочник API

Этот справочник описывает исключительно реальные, публично используемые JSON-эндпоинты — метод, путь, тип аутентификации, обязательные параметры, пример запроса и ответа, а также задокументированные коды ошибок для каждого эндпоинта. Общей системы API-ключей для разработчиков у Zentor нет; в зависимости от маршрута доступ осуществляется либо без аутентификации, либо через токен встраивания виджета с проверкой Origin. Внутренние маршруты панели управления и эндпоинты Master Admin намеренно не входят в этот публичный справочник, поскольку они доступны исключительно через обычную сессию входа.

Каждая запись эндпоинта содержит отметку о живом тесте, которая раскрывает, получены ли данные из схемы реестра, автоматизированного теста или фактического наблюдения в реальной работе — простое сходство с работающим участком кода при этом не считается полным доказательством. Кроме того, технически успешный вызов всегда подтверждает лишь обработку самого соответствующего запроса, а не автоматически последующие процессы, такие как доставка электронной почты, завершение платежа или завершённый вход через SSO.

Защита зависит от соответствующей группы. Публичные правовые, маркетинговые эндпоинты и эндпоинты форм не требуют сессии панели управления. Чат-виджет, напротив, использует заголовок `X-Widget-Token` и список разрешённых источников (Origin-Allowlist). Вход в панель управления выдаёт сессионный JWT со сроком действия двенадцать часов и refresh-токен со сроком действия семь дней. Эндпоинты SSO работают с собственными одноразовыми кодами и процессами обратного вызова (callback).

Рассматривайте каждую страницу эндпоинта как самостоятельный контракт. Решающее значение имеют HTTP-метод, путь, обязательные параметры, типы данных, тело запроса, структура ответа, коды ошибок и идемпотентность. Пример показывает возможный формат, но не заменяет проверку фактического ответа. Статус конфигурации, валидации, права доступа и внешние поставщики могут изменить результат.

Подтверждённый общеплатформенный лимит запросов составляет 2.000 запросов в течение 15 минут. Отдельные лимиты для каждого эндпоинта задокументированы не везде. Поэтому клиентам не следует использовать излишне частые циклы опроса (polling). При неидемпотентных операциях автоматические повторы могут создавать дублирующиеся записи или сообщения.

Конфиденциальные значения не должны попадать в логи. К ним относятся пароли, токены сброса, коды подтверждения, токены виджетов, идентификаторы сессий и реальные персональные данные в примерах. Используйте в документации и тестах анонимизированные значения. Отметки о живом тесте должны корректно отражать фактическое подтверждение.