推送活动数据

业务场景

  1. 推送某些活动数据给CP，例如组队信息等

注意事项

  1. CP 接口在响应之前，需做好签名校验
  2. http 请求的重试，可能会导致数据重复推送，需要做好去重处理
    • 可能存在网络异常，导致益世界调用游戏服务端超时，游戏服务端实际已成功发奖
    • 游戏服务端若收到同一dataType和dataKey认为是重复数据，需要忽略

流程图

接口地址

地址由CP提供

接口说明

  1. 协议：HTTPS
  2. 方式：POST
  3. ContentType：application/json;charset=utf-8
  4. 请求报文：
字段类型必需参与签名说明
gameIdint是是游戏ID
dataTypestring是是数据类型
dataKeystring是是数据key(同一组dataType和dataKey，重复接收到数据时，可以丢弃)
dataValuestring是是数据值
timestamplong是是毫秒时间戳
signstring是否签名
  1. 响应报文：
字段类型必需说明
codeint是响应状态码，0：成功，其它为失败
msgstring否响应描述

数据类型说明

组队信息

  • dataType：TEAM_INFO
  • dataKey: 组队标识
  • dataValue：JSON字符串数组
字段类型必需参与签名说明
userIdlong否是活动用户ID
openIdstring是是SDK用户唯一标识
serverIdstring是是游戏区服ID
roleIdstring是是游戏角色ID
roleNamestring是是游戏角色名称
  • 请求示例
{
  "gameId": 12345,
  "dataType": "TEAM_INFO",
  "dataKey": "33305f323531363733",
  "dataValue": "[{\"userId\":1000,\"openId\":\"12345678912345678912345\",\"serverId\":\"123456\",\"roleId\":\"1234567890\",\"roleName\":\"张三\",\"isCreator\":true},{\"userId\":1001,\"openId\":\"12345678912345678912346\",\"serverId\":\"123457\",\"roleId\":\"1234567891\",\"roleName\":\"李四\",\"isCreator\":false}]",
  "timestamp": 1742559434725,
  "sign": "9c72b86a06ac2ca93642847c55557b25"
}

响应示例

{
        "code": 0,
        "msg": "success"
}

签名规则

  1. 参数名区分大小写，按 ASCII 码从小到大排序（字典序）
  2. 只有值为 null 和 参数名不参与签名 的键值对，才不参与签名
  3. 使用 URL 键值对的格式，拼接成待签名字符串，签名 key 在最后拼接，再进行MD5计算
  4. 将生成的签名与入参 sign 值作校验，验签忽略大小写
String sign = md5(k1=v1&k2=v2...&key=appKey);

调试示例

import cn.hutool.crypto.SecureUtil;

import java.util.LinkedHashMap;
import java.util.Map;
import java.util.TreeMap;

public class Example {
    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 = new LinkedHashMap<>();
        notifyMap.put("gameId", 12345L);
        notifyMap.put("dataType", "TEAM_INFO");
        notifyMap.put("dataKey", "33305f323531363733");
        notifyMap.put("dataValue", "[{\"userId\":1000,\"openId\":\"12345678912345678912345\",\"serverId\":\"123456\",\"roleId\":\"1234567890\",\"roleName\":\"张三\",\"isCreator\":true},{\"userId\":1001,\"openId\":\"12345678912345678912346\",\"serverId\":\"123457\",\"roleId\":\"1234567891\",\"roleName\":\"李四\",\"isCreator\":false}]");
        notifyMap.put("timestamp", 1742559434725L);
        String appKey = "1234567890abcdef";
        System.out.printf("签名:%s%n", getMd5Sign(notifyMap, appKey));
    }
}

响应状态码

状态码说明
0成功
1000未知错误
1001验签失败
1002参数缺失
2001数据重复