获取角色详情

业务场景

  1. 用于从CP获取角色指定类型的数据

注意事项

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

接口地址

地址由CP提供

接口说明

  1. 协议：HTTPS
  2. 方式：POST
  3. ContentType：application/json;charset=utf-8
  4. 请求报文：
字段类型必需参与签名说明
gameIdint是是游戏项目ID
openidstring是是SDK用户唯一标识
serverIdstring是是游戏区服ID
roleIdstring是是游戏角色ID
actCodestring是是活动标识
dataTypesstring是是数据类型，多个用逗号分隔
timestamplong是是毫秒时间戳
signstring是否签名
  1. 响应报文：
字段类型必需说明
codeint是响应状态码，0：成功，其它为失败
msgstring否响应描述
dataarray是响应数据

data：

字段类型必需说明
dataTypestring是数据类型
datastring是数据值

请求示例

{
    "gameId": 12345,
    "openid": "12345678912345678912345",
    "serverId": "123456",
    "roleId": "1234567890",
    "dataTypes": "admissions,roleImg",
    "timestamp": 1668484881725,
    "sign": "9ed47ba0a9b6621efe611263fb8bbbc9"
}

响应示例

{
    "code": 0,
    "msg": "success",
    "data": [
        {
            "dataType": "admissions",
            "data": "{\"todayCount\":10,\"totalCount\":30}"
        },
        {
            "dataType": "roleImg",
            "data":"http://r-img.png"
        }
    ]
}

数据类型说明

招生次数

  • dataType：admissions
  • data：JSON字符串
字段类型必需说明
todayCountint是今日招生次数
totalCountint是总招生次数

角色头像

  • dataType：roleImg
  • data：头像图片地址

签名规则

  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", 12345);
        notifyMap.put("openid", 12345);
        notifyMap.put("serverId", "123456");
        notifyMap.put("roleId", "1234567890");
        notifyMap.put("dataTypes", "admissions,roleImg");
        notifyMap.put("timestamp", 1668484881725L);
        String appKey = "1234567890abcdef";
        System.out.printf("签名:%s%n", getMd5Sign(notifyMap, appKey));
    }
}

响应状态码

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