问卷发奖
业务场景
- 用户填写完问卷,由益世界通过该接口通知CP发放对应的奖励
注意事项
- Http 请求的重试,可能会导致数据重复推送,需要做好去重处理
- 可能存在网络异常,导致益世界的调用 CP 服务端超时,CP 服务端实际已成功发奖
- 同一个角色在同一个问卷只能发奖一次
- 唯一性校验:surveyId + serverId + roleId
- CP 服务端若收到同一发奖的重复回调,要避免重复给玩家发奖,造成损失
接口地址
地址由CP提供
接口说明
- 协议:HTTPS
- 方式:POST
- ContentType:application/json;charset=utf-8
- 请求报文:
名称 | 类型 | 是否必须 | 备注 |
---|---|---|---|
openId | string | 必须 | SDK用户唯一标识 |
roleId | string | 必须 | 游戏角色id |
serverId | string | 必须 | 游戏区服id |
surveyId | string | 必须 | 问卷id |
appId | string | 必须 | SDK的appId |
awardId | string | 必须 | 奖励id |
timestamp | long | 必须 | 时间戳,毫秒级 |
sdkExtend | object | 非必须 | 扩展信息,不参与签名 |
sign | string | 必须 | 签名,参考签名规则 |
sdkExtend内容
字段 | 类型 | 必需 | 说明 |
---|---|---|---|
cpGameArea | string | 否 | 游戏大区字段 |
- 响应报文:
字段 | 类型 | 必需 | 说明 |
---|---|---|---|
code | int | 是 | 响应状态码 |
msg | string | 否 | 响应描述 |
请求示例
{
"appId": 10070,
"awardId": "1=100211=5",
"openId": "174110665562001474225520",
"roleId": "530138",
"sdkExtend": {
"cpGameArea": "1"
},
"serverId": "1",
"sign": "d4092882e9a02e6d924fe8094d926766",
"surveyId": "yuVjBqsG",
"ts": 1741705667547
}
响应示例
{
"code": 0,
"msg": "success"
}
签名规则
- 参数名区分大小写,按 ASCII 码从小到大排序(字典序)
- 只有值为 null 和 参数名不参与签名 的键值对,才不参与签名
- 使用 URL 键值对的格式,拼接成待签名字符串,签名 key 在最后拼接,再进行MD5计算
- 将生成的签名与入参 sign 值作校验,验签忽略大小写
调试示例
import cn.hutool.crypto.SecureUtil;
import com.alibaba.nacos.shaded.com.google.common.collect.Maps;
import java.util.Map;
import java.util.TreeMap;
public class NotifyExample {
public static String getMd5Sign(Map<String, Object> params, String appKey) {
TreeMap<String, Object> sortedParams = new TreeMap(params);
StringBuilder builder = new StringBuilder(512);
sortedParams.forEach((k, v) -> {
if (v != null) {
builder.append(k).append("=").append(v).append("&");
}
});
builder.append("key=").append(appKey);
return SecureUtil.md5(builder.toString());
}
public static void main(String[] args) {
Map<String, Object> notifyMap = Maps.newLinkedHashMap();
notifyMap.put("openId", "12345678912345678912345");
notifyMap.put("serverId", "10158");
notifyMap.put("sdkOrderNo", "2019010515034700909471");
notifyMap.put("orderNo", "202151541584415");
notifyMap.put("amount", 600);
notifyMap.put("payTime", "2022-06-01 10:20:45");
notifyMap.put("timestamp", 1654142913840L);
String appKey = "AaBbCcDdEeFfGgHh";
System.out.println(String.format("发货签名:%s", getMd5Sign(notifyMap, appKey)));
}
}
状态码
状态码 | 说明 |
---|---|
0 | 成功 |
1000 | 未知错误,我方会继续通知3次 |
1001 | 验签失败 |
1002 | 数据不匹配,参数缺失/错误 |