获取微小凭据

业务场景

  1. 获取超级 SDK 对应小游戏的全局唯一的凭据 accessToken
  2. 调用小游戏平台的绝大多数后端接口时，都需使用 accessToken，开发者需要进行妥善保存
  3. 目前适用的小游戏，包括但不限：微信小游戏

注意事项

  1. 如果是微信小游戏，需要传 wx 类型，才能获取到微信小游戏的 accessToken
  2. 益世界有中控服务，定时主动刷新 accessToken，保证新老 accessToken 都是可用的
  3. 游戏方成功获得 accessToken 信息后，建议缓存起来，有效期内的凭据是不变的
  4. 使用 accessToken 遇到过期的错误响应，再来查本接口，没必要频繁查询

接口地址

https://cp.gzxianc.com/open-api/v1/extend/get/mini-game-token

接口说明

  1. 协议：HTTPS
  2. 方式：POST
  3. ContentType：application/json;charset=utf-8
  4. 请求报文：
字段类型必需参与签名说明
appIdlong是否游戏包中SDK实际使用的appId
channelIdlong是否游戏包中SDK实际使用的渠道Id
typestring是是类型：wx 代表微信小游戏
timestamplong是是毫秒时间戳
signstring是否签名
  1. 响应报文：
字段类型必需说明
codeint是响应状态码
msgstring是响应描述
dataobject否结果数据

data结构体

字段类型必需说明
accessTokenstring是小游戏的凭据 access_token
expiresInint是凭据剩余有效时长，单位：秒。目前是7200秒之内的值

请求示例

{
        "appId": 2003790,
        "channelId": 1400,
        "type": "wx",
        "timestamp": 1732675473367,
        "sign": "e2afe550f4847d8bf6ddf503c8c95db2"
}

响应示例

{
    "code": 0,
    "msg": "Success",
    "data": {
        "accessToken": "186_1V-QwI1111i-i1uw_YdYcGZ_wgMkzbdUsoNB2X0m4VyiYDtVfWt111111111_C1111111111hABAYKB",
        "expiresIn": 7167
    },
    "meta": {
        "tid": "8bcb2cec"
    }
}

签名规则

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

调试示例

import cn.hutool.crypto.SecureUtil;

import java.util.HashMap;
import java.util.Map;
import java.util.TreeMap;

public class SignExample {

    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("appId", 2003790L);
        reqMap.put("channelId", 1400L);
        reqMap.put("type", "wx");
        reqMap.put("timestamp", 1732675473367L);
        System.out.println(String.format("token签名:%s", getMd5Sign(reqMap, appKey)));
    }
}

状态码

状态码说明
0Success
11000参数为空
11001无效的参数
11002记录不存在
11003操作失败
11004无效的签名
22110渠道未支持实现
22111渠道未支持方法（具体报错内容会替换）
31009服务器开小差了，请稍后再试