Backend и API
Для серверных приложений, cron-задач, внутренних API и фоновых процессов.
Как выглядит поток
Ваш backend отправляет HTTPS POST на /v1/events с заголовком X-Ontik-Key. Ontik сохраняет заголовок и meta, а затем уведомляет проект.
Как подключить
События не должны зависеть от браузера пользователя. Передавайте в meta идентификаторы, источник, результат, severity и ссылку на подробности.
POST https://app.ontik.ru/v1/events
X-Ontik-Key: pk_live_ВАШ_КЛЮЧ
Content-Type: application/json
{
"event": "Импорт каталога завершён",
"meta": {
"job_id": "import-1048",
"processed": 820,
"errors": 2,
"result": "completed_with_errors"
}
}Пример данных события
| Поле | Пример | Зачем |
|---|---|---|
event | Резервная копия завершена | Короткий заголовок, который увидит команда. |
meta | server, duration_sec, result | Контекст для реакции и поиска. |
| Webhook URL | https://example.ru/api/ontik-webhook | Адрес вашей системы, если нужна исходящая доставка. |
meta передавайте ссылку и идентификатор.Конкретный пример
Ночная задача резервного копирования завершилась ошибкой, импорт каталога готов или генерация отчёта закончилась.
Порядок настройки
- После завершения нужного этапа сформируйте event и плоский meta.
- Отправьте POST из backend. Вызов не должен мешать основной операции: обрабатывайте сетевую ошибку у источника.
- Откройте событие и по job_id сопоставьте его с журналом задачи.
Результат и границы сценария
Команда получает итог задачи, не читая весь лог. Подробный журнал остаётся в backend; при необходимости передайте ссылку.
Примеры используют учебные данные. Публичная регистрация пока закрыта; адрес API указан для будущего запуска. Подключение можно проверить в вашей тестовой установке.
Подходит ли этот сценарий?
Да, если вам нужно быстро собрать сигнал из источника, сохранить его в общей ленте, уведомить владельца или команду и при необходимости передать его дальше через Webhook.