IGAW 奖励服务器集成
IGAW 的 adPOPcorn 和 优惠券服务中,需要向用户支付奖励的服务。
IGAW 奖励服务器是为了执行支付奖励,将需要的信息发送至回调服务器。
为接受并处理奖励支付信息,请参考以下指南创建回调服务器。
基本信息设置
在 adPOPcorn 管理页面中,设置接受回调的服务器基本信息。
需要输入的信息如下;
- 服务器 : 选择开发商自己的服务器
- 回调 URL : 接受奖励支付信息的回调服务器的 Live URL
- 测试回调 URL : 接受奖励支付信息的回调服务器的测试 URL
- HTTP 通信方式 : 发送回调的方式
- 奖励支付信息(*) : 为支付奖励所需要的奖励信息的参数
[示例]
(*)奖励支付信息
IGAW 奖励服务器传达的接受各奖励 Parameter 的 Key 价可以登录。
adPOPcorn 服务处基本 Parameter 外,还可添加需要接受的新增信息。
新增 Parameter (adPOPcorn)
- {campaign_name} : 用户参与完成的活动名称
- {campaign_type} : 用户参与完成的活动类型
- {app_key} : IGAWorks 应用 Key
- {app_name} : IGAWorks 应用名称
- {time_stamp} : 活动完成时间
- {adid} : 用户完成广告活动的设备的谷歌广告 ID
Protocol 测试
为了奖励服务器的集成工作更加便利,可以在网站中直接进行 Protocol 测试。
输入测试用的用户识别码,进行3个阶段的 Protocol 测试。
点击各 Protocol 测试的开始按钮,系统将把奖励信息示例传送至测试回调 URL。
回调应答
接受并处理从 IGAWorks 奖励服务器发送的奖励支付信息后,需使用 JSON 形式回传处理结果。
参考以下模板向 IGAWorks 奖励服务器回传应答。
不同情况下 JSON 答应模板
- 安全性验收失败
{"Result":false,"ResultCode":1100,"ResultMsg":"invalid signed value"} - 重复支付奖励
{"Result":false,"ResultCode":3100,"ResultMsg":"duplicate transaction"} - 用户检查失败
{"Result":false,"ResultCode":3200,"ResultMsg":"invalid user "} - 发生例外事件
{"Result":false,"ResultCode":4000,"ResultMsg":"custom error message"} - 成功进行奖励支付
{"Result":true,"ResultCode":1,"ResultMsg":"success"}
详细说明
各应答模板的使用情况如下;
- 安全性验收
IGAWorks 奖励服务器中,用 HMAC-MD5 方式加密,将传达的 (*)SignedValue 价和开发商服务器上创建的 SignedValue 价进行对比。如对比结果一致,即通过安全性验证。 - 防止重复支付奖励
为了防止用户通过统一 RewardKey 重复多次获取奖励的过程。
用户正常完成活动时,发放 RewardKey。此价时所有活动唯一的价。
传达的 RewardKey,如果已经完成支付处理的话,将不再支付奖励。 - 用户监测过程
根据 IGAWorks 奖励服务器传达的奖励支付信息中的用户信息,确认是否用该用户存在的过程。
若用户信息出错,将不会支付奖励。 - 发生例外事件
除以上错误事件外,适用于当发生其他事件时的处理方法。
在 ResultMsg 可按情况直接设置信息。(必须用英文设置) - 奖励支付处理成功
对于未发生以上错误事件的奖励支付信息,完成奖励支付处理后,将结果发送给 IGAWorks 奖励服务器。
(*)SignedValue : 为了进行安全性验收而使用的加密字符串。IGAWorks 服务器中将基本的回调参数 (usn,rewardkey,quantity,campaignkey) plainText,将生成的 SignedValue 添加至回调中一起传送。在开发商回调服务器中也通过同样的方式来生成 SignedValue,和从 IGAWorks 接收到的价进行对比。
Sample Code (c#, php)
回调服务器中应准守以上定义的 Protocol Interface,根据各个情况向 IGAWorks 奖励服务器回传应答。
以下提供回调服务器构造相关的 C#, PHP 示例代码。
请参考如链接可下载示例代码。