Быстрый старт
Получайте мгновенные уведомления, когда появляются срочные новости. Вебхуки доставляют обновления статей в реальном времени прямо в ваше приложение, устраняя необходимость постоянного опроса API.
Что такое вебхуки?
Считайте вебхуки мгновенными уведомлениями для вашего приложения. Когда появляется новость, соответствующая вашим критериям, finlight немедленно отправляет данные статьи на указанный вами эндпоинт.
Как работают вебхуки
Вот полный процесс простыми словами:
- Настройка - задайте вебхук с конкретными критериями новостей
- Мониторинг - наша система отслеживает новые статьи круглосуточно
- Совпадение - когда статья соответствует вашим критериям, мы мгновенно её обнаруживаем
- Доставка - мы отправляем данные статьи прямо на ваш эндпоинт
Этот подход «обратного API» означает, что ваше приложение получает обновления в момент их появления, а не запрашивает их многократно.
Начало работы
Что вам понадобится
Прежде чем создавать первый вебхук, убедитесь, что у вас есть:
- Активная подписка finlight с доступом к вебхукам
- Публичный HTTPS-эндпоинт, готовый принимать вызовы вебхуков
- Доступ к панели управления на app.finlight.me
Быстрый доступ
Перейдите сразу к созданию вебхука, открыв app.finlight.me/news-webhooks и войдя в свою учётную запись finlight.
Создание первого вебхука
Следуйте этому простому процессу из 4 шагов, чтобы настроить вебхук и начать получать обновления новостей в реальном времени.
Шаг 1. Откройте конструктор вебхуков
- Войдите в панель управления finlight на app.finlight.me
- Перейдите к пункту «Webhooks» в главном меню
- Нажмите «New Webhook», чтобы запустить мастер настройки
Шаг 2. Основные сведения
Дайте вебхуку понятное название и выберите тип доставки:
- Имя - выберите что-то описательное, например «Срочные техноновости» или «Обновления рынка»
- Описание - необязательное краткое пояснение назначения вебхука
- Тип доставки - выберите, как должны доставляться статьи:
- Обогащённый (по умолчанию) — обработанная ИИ полезная нагрузка с данными о компаниях, тональностью и полными параметрами фильтрации. См. руководство Обогащённые вебхуки.
- Необработанный — более быстрая доставка, упрощённая полезная нагрузка, ограниченные фильтры. См. руководство Необработанные вебхуки.
Шаг 3. Задайте критерии новостей
Настройте фильтрацию, чтобы получать только релевантные статьи. Доступные параметры зависят от выбранного типа доставки.
См. Обогащённые вебхуки или Необработанные вебхуки для полного справочника фильтров вашего типа.
Шаг 4. Настройте назначение и безопасность
Назначение вебхука
Укажите URL вашего эндпоинта, куда мы будем отправлять новости:
- Должен быть публичным HTTPS-URL
- Должен отвечать быстро (менее 5 секунд)
Настройка безопасности
Выберите способ защиты эндпоинта вебхука:
- Нет - без дополнительной аутентификации (не рекомендуется для продакшена)
- Базовая аутентификация - защита логином/паролем через HTTP Basic Auth
- Пользовательский заголовок - отправляйте свой ключ API в заголовке
X-Finlight-Key - Проверка подписи - всегда включена для проверки полезной нагрузки через заголовок
X-Webhook-Signature
Примечание. Проверка подписи автоматически включается для всех вебхуков для проверки целостности полезной нагрузки, независимо от выбранного метода аутентификации.
Узнайте больше о реализации этих параметров безопасности в нашем руководстве по аутентификации.
Тестирование интеграции
Встроенные инструменты тестирования
Перед запуском проверьте настройку вебхука:
- Функция тестирования в панели - отправляйте образцы полезной нагрузки на свой эндпоинт
- Мониторинг доставки - отслеживайте уровень успешных доставок и время отклика
- Диагностика ошибок - отлаживайте неудавшиеся доставки
Подробные инструкции по тестированию, примеры полезной нагрузки и советы по устранению неполадок см. в нашем руководстве по тестированию вебхуков.
Нужна помощь?
Быстрые варианты поддержки
Полезная нагрузка и фильтрация
См. Обогащённые вебхуки или Необработанные вебхуки для модели статьи и справочника фильтров вашего типа.
Техническая настройка
Обратитесь к нашему руководству по аутентификации и руководству по тестированию за подробной помощью по реализации.
Общая поддержка
Дополнительные ресурсы и контактную информацию см. на нашей странице поддержки.
Проблемы с панелью
Доступ к управлению вебхуками — на app.finlight.me, или обратитесь в поддержку через платформу.
Готовы начать?
Вебхуки меняют то, как вы получаете обновления новостей, — от опроса каждые несколько минут к мгновенной доставке в момент появления новости.
Начните с простого — с базовых критериев фильтрации, а затем постепенно расширяйте, по мере того как поймёте, что лучше всего подходит для вашего приложения. Панель управления finlight позволяет легко изменять и оптимизировать вебхуки в любое время.