快速开始
在突发新闻发生时即时获得通知。Webhooks 将实时的文章更新直接投递到您的应用,无需持续轮询 API。
什么是 Webhooks?
可以把 webhooks 看作是为您的应用提供的即时通知。当符合您条件的新闻发生时,finlight 会立即将文章数据发送到您指定的端点。
Webhooks 的工作原理
以下是简单来说的完整流程:
- 配置 —— 使用特定的新闻条件设置您的 webhook
- 监控 —— 我们的系统全天候 24/7 监视新文章
- 匹配 —— 当某篇文章符合您的条件时,我们会即时检测到
- 投递 —— 我们将文章数据直接发送到您的端点
这种**“反向 API”**方式意味着您的应用会在更新发生的那一刻就收到它,而不必反复请求。
开始使用
您需要准备的内容
在创建第一个 webhook 之前,请确保您已具备:
- 有效的 finlight 订阅且包含 webhook 访问权限
- 准备好接收 webhook 调用的公开 HTTPS 端点
- 在 app.finlight.me 的控制台访问权限
快速访问
访问 app.finlight.me/news-webhooks 并登录您的 finlight 账户,直接开始创建 webhook。
创建您的第一个 Webhook
按照这个简单的 4 步流程设置您的 webhook,开始接收实时新闻更新。
第 1 步:进入 Webhook 创建器
- 在 app.finlight.me 登录您的 finlight 控制台
- 在主菜单中导航到 “Webhooks”
- 点击 “New Webhook” 启动设置向导
第 2 步:基本信息
为您的 webhook 设定清晰的标识并选择投递类型:
- 名称 —— 选择具有描述性的名称,例如“突发科技新闻”或“市场动态”
- 描述 —— 对该 webhook 用途的可选简短说明
- 投递类型 —— 选择文章的投递方式:
- 丰富型 (默认) —— 经 AI 处理的负载,包含公司数据、情绪以及完整的过滤选项。参见丰富型 Webhooks指南。
- 原始 —— 投递更快、负载更简化、过滤器有限。参见原始 Webhooks指南。
第 3 步:定义您的新闻条件
配置过滤条件,仅接收相关文章。可用选项取决于您所选的投递类型。
有关您类型的完整过滤参考,请参见丰富型 Webhooks或原始 Webhooks。
第 4 步:设置目标地址与安全性
Webhook 目标地址
提供我们用于发送新闻的端点 URL:
- 必须是公开的 HTTPS URL
- 应快速响应(5 秒以内)
安全设置
选择如何保护您的 webhook 端点:
- 无 —— 不进行额外认证(不建议用于生产环境)
- 基本认证 —— 通过 HTTP Basic Auth 进行用户名/密码保护
- 自定义标头 —— 在
X-Finlight-Key标头中发送您的 API 密钥 - 签名验证 —— 始终包含,通过
X-Webhook-Signature标头进行负载验证
注意: 无论您选择哪种认证方式,签名验证都会在所有 webhook 上自动启用,用于验证负载完整性。
了解更多关于实现这些安全选项的内容,请参阅我们的认证指南。
测试您的集成
内置测试工具
在正式上线之前,验证您的 webhook 设置:
- 控制台测试功能 —— 向您的端点发送示例负载
- 投递监控 —— 跟踪成功率和响应时间
- 错误诊断 —— 调试失败的投递
有关全面的测试说明、负载示例和故障排除技巧,请访问我们的 webhook 测试指南。
需要帮助?
快速支持选项
负载与过滤
有关您类型的文章模型和过滤参考,请参见丰富型 Webhooks或原始 Webhooks。
技术设置
访问我们的认证指南和测试指南以获取详细的实现帮助。
一般支持
查看我们的支持页面以获取更多资源和联系方式。
控制台问题
在 app.finlight.me 访问您的 webhook 管理,或通过平台联系支持。
准备好开始了吗?
Webhooks 改变了您接收新闻更新的方式 —— 从每隔几分钟轮询一次,变为在新闻发生的那一刻即时投递。
从简单开始,使用基本的过滤条件,然后随着您发现最适合应用的方式而逐步扩展。finlight 控制台让您随时都能轻松修改和优化您的 webhook。