设置Webhook
Webhook是系统中发生的事件的通知。发生特定事件时,艾克索拉会向您的应用程序发送一个传送事件数据的HTTP请求,通常是JSON格式的POST
请求。
事件示例:
- 用户与商品目录进行了交互
- 支付或取消了订单
Webhook列表
如希望接收事件通知,请实现Webhook处理:
- 支付 — 订单付款时发送,包含支付数据及交易详情。
- 订单成功支付 — 成功处理支付Webhook时发送,包含所购商品的信息以及交易ID。
- 退款 — 订单取消时发送,包含取消的付款数据及交易详情。
- 订单取消 — 成功处理退款Webhook时发送,包含所购商品及取消的交易的ID信息。
用户验证 — 在支付过程的不同阶段发送,以确保用户已在游戏中注册。包含购买游戏密钥的用户的信息。
如您的应用程序侧实现了商品目录个性化,请设置合作伙伴侧目录个性化的处理。
如使用外部ID(您自己系统上的交易ID)并希望将其与艾克索拉侧的交易ID关联或传入额外交易参数,请实现交易ID的关联Webhook。
在发布商帐户中设置Webhook
要启用Webhook接收:
- 在发布商帐户中打开您的项目。
- 在侧边栏中单击项目设置,然后前往Webhooks选项卡。
- 在Webhook服务器字段中指定要接收Webhook的服务器URL,格式为
https://example.com
。您也可以指定在工具中找到的URL来用于测试。
- 默认会生成一个用于项目Webhook签名的密钥。如要生成新密钥,请点击刷新图标。
- 单击启用Webhook。
- 在发布商帐户中打开您的项目。
- 在侧边栏中单击项目设置,然后前往Webhooks选项卡。
- 单击禁用Webhook。
在发布商帐户中测试Webhook
您可以测试以下Webhook的接收:
如成功设置了Webhook,Webhook设置区块下方会显示一个Webhook测试区块。
Webhook监听器
Webhook监听器是一个程序代码,可以在指定的URL地址接收传入的Webhook、生成签名及向艾克索拉Webhook服务器发送响应。
生成签名
接收Webhook时,应确保数据传输的安全性。为此,必须从Webhook数据生成一个签名并确保它与HTTP请求头中发送的签名匹配。
要生成签名:
- 将请求正文中的JSON与项目密钥串联起来。
- 对第一步中得到的字符串应用SHA-1加密散列函数。
向Webhook发送响应
要确认收到Webhook,您的服务器必须返回:
200
、201
或204
HTTP代码(成功响应时)。- 带问题描述的
400
HTTP代码(如未找到指定用户或传入的签名无效)。
如您的服务器发生临时问题,您的Webhook处理程序也可以返回5xx
代码。
如果未收到对订单成功支付或订单取消Webhook的响应,或收到了包含5xx
代码的响应,将根据以下规则重新发送Webhook:
- 间隔5分钟尝试2次
- 间隔15分钟尝试7次
- 间隔60分钟尝试10次
自首次尝试起,12小时内最多尝试发送Webhook20次。
如果未收到对支付Webhook的响应或收到了包含5xx
代码的响应,也将尝试重新发送Webhook且重试的间隔逐渐拉长。12小时内最多尝试12次。
如果未收到对用户验证Webhook的响应或收到了包含400
或5xx
代码的响应,将不会重新发送用户验证Webhook。
该情况下会向用户显示一个错误,且不会发送支付和订单成功支付Webhook。
发现了错别字或其他内容错误? 请选择文本,然后按Ctrl+Enter。