Довідник API
Публічні ендпоінти API для розробників: форми, віджет, конфігуратор продуктів та інше.
Цей довідник описує виключно справжні, публічно доступні JSON-кінцеві точки -- метод, шлях, тип автентифікації, обов'язкові параметри, приклад запиту та відповіді, а також задокументовані коди помилок для кожної кінцевої точки. Загальної системи API-ключів для розробників у Zentor немає; доступ здійснюється залежно від маршруту або без автентифікації, або через Widget-Embed-Token із перевіркою Origin. Внутрішні маршрути панелі керування та кінцеві точки Master Admin свідомо не входять до цього публічного довідника, оскільки вони доступні виключно через звичайну сесію входу.
Кожен запис кінцевої точки має позначку живого тесту, яка розкриває, чи походить інформація зі схеми реєстру (Registry), з автоматизованого тесту чи з фактичного спостереження в робочому режимі -- проста схожість із працюючим шляхом коду при цьому не вважається повним доказом. Крім того, технічно успішний виклик завжди підтверджує лише обробку самого відповідного запиту, а не автоматично подальші процеси, як-от доставку ел. листа, завершення платежу чи завершений вхід через SSO.
Захист залежить від відповідної групи. Публічним юридичним і маркетинговим кінцевим точкам, а також кінцевим точкам форм не потрібна сесія панелі керування. Натомість чат-віджет використовує заголовок `X-Widget-Token` і Origin-Allowlist. Входи в панель керування видають сесійний JWT із терміном дії дванадцять годин і refresh-токен, дійсний сім днів. Кінцеві точки SSO працюють із власними одноразовими кодами та процесами callback.
Читайте кожну сторінку кінцевої точки як окремий контракт. Вирішальними є HTTP-метод, шлях, обов'язкові параметри, типи даних, тіло запиту, структура відповіді, коди помилок та ідемпотентність. Приклад показує можливий формат, але не замінює перевірки фактичної відповіді. Стан конфігурації, валідації, дозволи та зовнішні постачальники можуть змінити результат.
Підтверджене загальноплатформне обмеження частоти становить 2 000 запитів протягом 15 хвилин. Окремі обмеження для кожної кінцевої точки задокументовано не повністю. Тому клієнтам не слід використовувати надмірно щільні цикли опитування (polling). Для неідемпотентних операцій автоматичні повтори можуть створювати дублікати записів або повідомлень.
Чутливим значенням не місце в журналах. До них належать паролі, токени скидання, коди підтвердження, токени віджета, ідентифікатори сесій і реальні персональні дані в прикладах. Використовуйте в документації та тестах анонімізовані значення. Примітки про живі тести мають правильно відображати фактичний доказ.