问卷发奖

业务场景

  1. 用户填写完问卷,由益世界通过该接口通知CP发放对应的奖励

注意事项

  1. Http 请求的重试,可能会导致数据重复推送,需要做好去重处理
    • 可能存在网络异常,导致益世界的调用 CP 服务端超时,CP 服务端实际已成功发奖
    • 同一个角色在同一个问卷只能发奖一次
    • 唯一性校验:surveyId + serverId + roleId
    • CP 服务端若收到同一发奖的重复回调,要避免重复给玩家发奖,造成损失

接口地址

地址由CP提供

接口说明

  1. 协议:HTTPS
  2. 方式:POST
  3. ContentType:application/json;charset=utf-8
  4. 请求报文:
名称类型是否必须备注
openIdstring必须SDK用户唯一标识
roleIdstring必须游戏角色id
serverIdstring必须游戏区服id
surveyIdstring必须问卷id
appIdstring必须SDK的appId
awardIdstring必须奖励id
timestamplong必须时间戳,毫秒级
sdkExtendobject非必须扩展信息,不参与签名
signstring必须签名,参考签名规则

sdkExtend内容

字段类型必需说明
cpGameAreastring游戏大区字段
  1. 响应报文:
字段类型必需说明
codeint响应状态码
msgstring响应描述

请求示例

{
    "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"
}

签名规则

  1. 参数名区分大小写,按 ASCII 码从小到大排序(字典序)
  2. 只有值为 null 和 参数名不参与签名 的键值对,才不参与签名
  3. 使用 URL 键值对的格式,拼接成待签名字符串,签名 key 在最后拼接,再进行MD5计算
  4. 将生成的签名与入参 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数据不匹配,参数缺失/错误