获取角色归因

业务场景

用于从 CP 获取某个角色id的归因信息

注意事项

CP 接口在响应之前，需做好签名校验

接口地址

地址由CP提供

接口说明

  1. 协议：HTTPS
  2. 方式：POST
  3. ContentType：application/json;charset=utf-8
  4. 请求报文：
字段类型必需参与签名说明
gameIdlong是是游戏项目ID(并非出包的 appId)
roleIdstring是是游戏角色ID
timestamplong是是毫秒时间戳
signstring是否签名
  1. 响应报文：
字段类型必需说明
codeint是响应状态码，0：成功，其它为失败
msgstring是响应描述
dataobject是响应数据

data结构体

字段类型必需说明
appIdlong是游戏包中SDK实际使用的appId
channelIdlong是游戏包中SDK实际使用的渠道id
openIdstring是SDK用户唯一标识
serverIdstring是游戏区服ID
serverNamestring是游戏区服名称
roleIdstring是游戏角色ID
roleNamestring是游戏角色名称
roleLevelint是游戏角色等级

请求示例

{
    "gameId": 21573,
    "roleId": "2700033751",
    "timestamp": 1668484881725,
    "sign": "06f219288149344bc1fc77a224cf3604"
}

响应示例

{
	"code": 0,
	"msg": "成功",
	"data": {
		"appId": 2001234,
		"channelId": 1302,
		"openId": "12345678912345678912345",
		"serverId": "4011230",
		"serverName": "巨富30区",
		"roleId": "2700033751",
		"roleName": "云卷云舒",
		"roleLevel": 19
	}
}

签名规则

  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) {
        String appKey = "AaBbCcDdEeFfGgHh";
        Map<String, Object> reqMap = new HashMap<>();
        reqMap.put("gameId", 21573);
        reqMap.put("roleId", "2700033751");
        reqMap.put("timestamp", 1668484881725L);
        System.out.println(String.format("角色归因签名:%s", getMd5Sign(reqMap, appKey)));
    }
}

响应状态码

状态码说明
0成功
1000未知错误
1001验签失败
1002参数缺失
2001角色不存在