配置 Webhooks

设置

您可以使用Yuno 面板配置网络钩子:

  1. 导航至 "开发人员"选项卡
  2. 点击Webhooks
  3. 单击添加网络钩子

将打开一个侧边栏,在此进行配置:

  • 名称:标识网络钩子
  • Endpoint URL:接收通知的服务器 URL
  • x-api-key: 您的 API 密钥(在通知头中发送)
  • x-secret: 您的秘密(在通知标题中发送)
  • 使用 OAuth2 身份验证:用于 OAuth2 的可选复选框
  • 使用 HMAC 验证:用于 HMAC 签名验证的可选复选框

触发:选择哪些事件会触发该网络钩子(注册、付款、订阅等)

配置完成后,只要发生选定的事件,网络钩子就会发送通知。下图显示了添加网络钩子的侧边面板。

Yuno 面板"开发人员 "选项卡中,您可以使用 "状态"切换按钮激活或停用网络钩子。

访问Webhooks 示例页面,查看付款、注册和许多其他通知事件的示例。

HMAC 验证

当您启用 使用 HMAC 验证 在仪表板中,您将提供一个客户端秘钥。Yuno 将使用此密钥生成 HMAC 签名,并将其发送到 x-hmac-signature 每个网络钩子请求都会包含 HTTP 标头,让你可以验证网络钩子是否真正来自 Yuno,并且没有被篡改。

有关实施细节,请参阅验证 Webhook 签名 (HMAC)指南。

oAuth2

在仪表板中启用 "使用 OAuth2 token "后,您可以配置以下参数,这样 Yuno 就能获取将在 webhook 头信息中发送的授权token :

  • Authentication_url:用于身份验证的网址
  • Credentials:与 authentication_url 通信所需的凭证。
    • 客户密钥
    • 客户 客户 ID
  • Grant type:验证授权类型。

收货确认流程

Yuno 网络钩子希望收到 HTTP 200 OK 状态作为响应,以表明网络钩子已收到。商家系统的响应不需要提供有关请求正文的任何信息,只需提供 HTTP 200 状态。如果在指定时间内未收到响应,Yuno 网络钩子最多会发送七次事件通知,以避免信息丢失。下表列出了 Webhooks 通知时间表和确认等待时间。

活动

初试后的截止日期

第一次尝试


第二次尝试

5 分钟

第三次尝试

50 分钟

第四次尝试

6 小时

第五次尝试

24 小时

第六次尝试

48 小时

第七次尝试

96 小时

Webhooks 事件类型

根据事件类型的不同,您将收到不同类型的 webhook 和事件。下表列出了当前可用的注册和付款事件类型。

类型事件类型
注册注册
注册注销
注册到期
payment购买
payment授权
payment捕捉
payment退款
payment取消
payment核对
payment扣款
payment欺诈筛查
赔款赔款
订阅费创建
订阅费暂停
订阅费简历
订阅费活跃
订阅费取消
订阅费完整
到职创建
到职未决
到职成功
到职已取消
到职拒绝
到职受阻
到职畅通无阻

subscription.active 仅当订阅从任何其他有效状态转换为 ACTIVE若订阅已处于活动状态,则不会触发任何webhook。

欺诈筛查 Webhook 行为

当交易被欺诈筛查拒绝,且未进入任何提供商的处理程序时,不会创建任何交易 - 即交易不会被创建。 transactions 数组返回空值。在这种情况下,只有在 fraud_screening 对象,触发的网络钩子是 payment.fraud_screening.

如果由于路由配置的原因,欺诈筛查被拒绝,但交易仍在处理中,则发送给客户端的事件为 payment.purchase.