获取Access Token

---

1 基础概念

access_token 是接口的全局唯一票据，接入方调用各接口时都需使用 access_token。
开发者需要妥善保存，access_token 的存储至少要保留 512 个字符空间。
access_token 的有效期目前为 2 个小时，需定时刷新。

接入方可以使用 app_id 和 ServerSecret 调用本接口来获取 access_token。

请注意：

1. app_id 和 ServerSecret 需要从 ZEGO 控制台 获取。
2. 调用所有接口时均需使用 https 协议。

2 请求说明

http请求方式: POST/JSON，需使用https。

json_str 内容如下：

{
    "version": 1,
    "seq": 1,
    "app_id": 11,
    "biz_type": 0,
    "token": "TOKEN"
}

3 参数说明

token 生成规则说明：

tokenInfo = '{
    "ver": 1,
    "hash": "adfdkjakka1213aa",
    "nonce": "1934892311",
    "expired": 1531393997 //单位:秒
}'
注意这里要先构造 JSON，再转成字符串

token = base64(tokenInfo)

tokenInfo 字段说明：

tokenInfo 中的 hash 字段生成规则说明：

4 返回说明

正常情况下，会返回下述 JSON 数据包给调用方：

{
    "code": 0,
    "data": {
        "access_token": "c205dytwQTd4ZlZjSjBLTXY0V3FzYUtBY1Q9ZEo0eGFJcEt3WVBKSlFGeXh5aGZITjJWYnlBcT0",
        "expires_in": 7200
    },
    "message": "success"
}

返回参数说明：

错误时会返回错误码等信息，JSON 数据包示例如下（该示例为 server_app_secret 无效错误）:

{
    "code": 40005,
    "message": "appsecret错误"
}

5 获取token示例代码

5.1 Java示例代码

package demo;

import java.io.UnsupportedEncodingException;
import java.security.*; 
import java.util.*;

import com.alibaba.fastjson.*;

public class tokenTest {

    public static void main(String[] args) throws UnsupportedEncodingException {
        long current_time = System.currentTimeMillis()/1000; //获取当前unix时间戳
        long expired_time = current_time+7200; //过期unix时间戳，单位：秒

        String appid = "000000000";  // 这里填写各自分配的appid
        String serverSecret = "00000000000000000000000000";  // 这里填写对应的ServerSecret
        String nonce = "xxxxxxxxx"; //自定义的随机数
        //System.out.println(current_time);
        //System.out.println(expired_time);

        // 待加密信息
        String originString = appid + serverSecret + nonce + Long.toString(expired_time);
        //待加密的信息
        //System.out.println(originString);
        //hash加密
        String hashString = getMD5(originString);
        //加密后的hash
        System.out.println("--hashString--:"+hashString);

        //定义一个tokeninfo json 
        LinkedHashMap  hashMap = new LinkedHashMap();

        hashMap.put("ver",1);
        hashMap.put("hash",hashString);
        hashMap.put("nonce",nonce);
        hashMap.put("expired",expired_time);
        String  tokeninfo= JSON.toJSONString(hashMap);
        //System.out.println("----------hashMap--------"+hashMap);
        //System.out.println("----------111--------"+tokeninfo);

        //Base64 加密
        final Base64.Encoder encoder = Base64.getEncoder();   //加密
        //final Base64.Decoder decoder = Base64.getDecoder();   //解密
        final byte[] textByte = tokeninfo.getBytes("UTF-8");

        final String encodedText = encoder.encodeToString(textByte);
        System.out.println("--token--:"+encodedText);
    }

    //生成MD5
    public static String getMD5(String message) {
        String md5 = "";
        try {
            MessageDigest md = MessageDigest.getInstance("MD5");  // 创建一个md5算法对象
            byte[] messageByte = message.getBytes("UTF-8");
            byte[] md5Byte = md.digest(messageByte);              // 获得MD5字节数组,16*8=128位
            md5 = bytesToHex(md5Byte);                            // 转换为16进制字符串
        } catch (Exception e) {
            System.out.println("erro md5 creat!!!!");
            e.printStackTrace();
        }
        return md5;
    }

     // 二进制转十六进制
    public static String bytesToHex(byte[] bytes) {
        StringBuffer hexStr = new StringBuffer();
        int num;
        for (int i = 0; i < bytes.length; i++) {
            num = bytes[i];
             if(num < 0) {
                 num += 256;
            }
            if(num < 16){
                hexStr.append("0");
            }
            hexStr.append(Integer.toHexString(num));
        }
        return hexStr.toString();
    }
}

/**
 * 最后，将生成的Token复制到以下curl -X POST替换掉其中的token，修改对应的app_id，然后取请求得到正确的"access_token"
 * 
 * */

// curl -X POST https://liveroom{app_id}-api.zego.im/cgi/token -d '{"version": 1,"seq": 1,"app_id": 000000000,"biz_type": 0,"token": token}'

5.2 php示例代码

<?php

$current_time = time(); //获取当前时间
$expired_time = $current_time + 7200; //过期时间，单位：秒

$app_id = 000000000; // Int类型,这里填写各自分配的appid
$server_app_secret = "00000000000000000000000000"; // 这里填写对应的ServerSecret
$nonce = "xxxxxxxxx"; //自定义的随机数

// 待加密信息
$origin = $app_id . $server_app_secret . $nonce . $expired_time;

//hash加密
$hash = md5($origin);

$token = [
    'ver' => 1,
    'hash' => $hash,
    'nonce' => $nonce,
    'expired' => $expired_time
];
//定义一个tokeninfo json 
$token = json_encode($token);

//Base64 加密
$encode_token = base64_encode($token);

echo $encode_token;

/**
 * 最后，将生成的Token复制到以下curl -X POST替换掉其中的token，修改对应的app_id，然后取请求得到正确的"access_token"
 * 
 * */

// curl -X POST https://liveroom{app_id}-api.zego.im/cgi/token -d '{"version": 1,"seq": 1,"app_id": 000000000,"biz_type": 0,"token": token}'

5.3 python示例代码

import time
import hashlib
import base64
import json


def buildToken():

    current_time = int(time.time()) # 当前unix时间戳
    expired_time = int(current_time + 7200) # 过期unix时间戳，单位：秒
    print("当前时间: " + str(int(current_time)))
    print("过期时间: " + str(int(expired_time)))

    appid = '123456789' # 分配给客户的appid
    serverSecret = '12345678123456781234567812345678' # 这里填写对应的ServerSecret
    nonce = '1234567812345678' # 建议使用随机串

    # 待加密信息
    aStr = appid + serverSecret + nonce + str(expired_time)
    print("未hash的串: " + aStr)
    # hash加密
    md5Obj = hashlib.md5()
    md5Obj.update(aStr.encode(encoding='utf-8'))
    # hashStr后的字符串
    hashStr = md5Obj.hexdigest()
    print("hashStr后的字符串: " + hashStr)

    # tokeninfo
    tokenInfo = {'ver':1,'hash':hashStr,"nonce":nonce,"expired":expired_time}
    tokenInfo = json.dumps(tokenInfo)

    token = base64.b64encode(bytes(tokenInfo,'ascii')).decode()
    print(token)
    return token


if __name__ == '__main__':
    buildToken()

#
# 最后，将生成的Token复制到以下curl -X POST替换掉其中的token，修改对应的app_id，然后取请求得到正确的"access_token"
# 

# curl -X POST https://liveroom{app_id}-api.zego.im/cgi/token -d '{"version": 1,"seq": 1,"app_id": 000000000,"biz_type": 0,"token": token}'