getToken

获取访问令牌

通过 API 方式获取访问令牌。

接口信息

URL	https://ws.xxx.com/auth/getToken
请求方式	POST

请求参数

Body

字段名称	类型	是否必选	说明
accessKeyId	String	是	用户访问密钥ID （获取方式）
accessTimestamp	String	是	13位当前Unix时间戳，值为请求发出前15分钟内的时间戳
accessNonce	String	是	签名唯一随机数，用于防止网络重放攻击，建议每次请求使用不同随机数
accessVersion	String	是	认证算法版本，当前固定值为V2
accessSign	String	是	签名。计算方式参考：鉴权
botId	String	否	设备唯一标识 （获取方式）。botId与vendorId二者必选其一
vendorId	String	否	厂商唯一标识 （获取方式）。botId与vendorId二者必选其一

vendorId使用场景

新设备配网后，设备自动注册平台，获取设备唯一标识（botId）

botId使用场景

设备已注册，使用设备botId获取访问授权，调用语音、文本对话等API服务

请求示例

curl --location 'https://ws.xxx.com/auth/getToken' \
--header 'Content-Type: application/json' \
--data '{
    "accessVersion": "V2",
    "accessTimestamp": "1234567890",
    "accessNonce": "a",
    "accessKeyId": "1",
    "accessSign": "2",
    "botId": "1"
}'

注意：参数botId与vendorId同时存在时，优先使用botId生成授权令牌

响应参数

Body

字段名称	类型	是否必选	说明
accessToken	String	是	用户访问令牌
expireIn	Integer	是	访问令牌过期时间（秒）,有效期2小时，失效后重新生成或使用refreshToken生成新accessToken
refreshToken	String	是	刷新令牌，有效期为7天，有效期内可以刷新accessToken，失效后需重新获取
refreshExpireIn	Integer	是	刷新令牌过期时间（秒）
code	Integer	是	状态码
msg	String	是	状态对应信息

响应示例

{
  "accessToken": "ehuc2065edbru==",
  "expireIn": 7200,
  "refreshToken": "cjekcnlsjfekncejh==",
  "refreshExpireIn": 604800,
  "code": 0,
  "msg": ""
}

PostMan请求示例

Pre-request Script

// 1. 参数准备阶段
const accessKeyId = "你的密钥Access Key";
const accessKeySecret = "你的密钥AccessKey Secret";
const accessVersion = "V2";

// 2. 生成动态参数
const accessTimestamp = Date.now().toString();
const accessNonce = Array.from(crypto.getRandomValues(new Uint8Array(16))).map(b => b.toString(16).padStart(2, '0')).join('');

// 3. 参数排序与拼接
const params = {
    accessKeyId: accessKeyId,
    accessTimestamp: accessTimestamp,
    accessNonce: accessNonce,
    accessVersion: accessVersion
};
const sortedEntries = Object.entries(params).sort(([k1], [k2]) => k1.localeCompare(k2));
const queryString = sortedEntries.map(([k, v]) => `${k.toLowerCase()}=${v}`).join('&');

// 4. HMAC-MD5签名计算
const CryptoJS = require('crypto-js');
const hexSignature = CryptoJS.HmacMD5(queryString, accessKeySecret).toString();

// 5. 将签名相关值放入环境变量，如果postman版本是v5.x及以下使用postman.setEnvironmentVariable替换pm.environment.set
pm.environment.set("accessSign", hexSignature);
pm.environment.set("accessTimestamp", accessTimestamp);
pm.environment.set("accessNonce", accessNonce);
pm.environment.set("accessKeyId", accessKeyId);
pm.environment.set("accessVersion", accessVersion);

Body

{
  "accessVersion": "{{accessVersion}}",
  "accessTimestamp": "{{accessTimestamp}}",
  "accessNonce": "{{accessNonce}}",
  "accessKeyId": "{{accessKeyId}}",
  "accessSign": "{{accessSign}}",
  "vendorId": "",
  "botId": ""
}

Python版代码示例

import binascii
import hashlib
import hmac
import time
import uuid
from urllib.parse import urlencode
import requests

accessKeyId = ''
accessKeySecret = ''
botId = None
vendorId = None

url = 'https://ws.xxx.com/auth/getToken'
params = {}

params["accessVersion"] = 'V2'
params["accessTimestamp"] = str(int(round(time.time() * 1000)))
params["accessNonce"] = str(uuid.uuid4())
params["accessKeyId"] = accessKeyId

print('1. 参数列表:', params)

# 将params的key转为小写并排序
lowerKeyParams = {k.lower(): params[k] for k in params}
sortedParams = sorted(lowerKeyParams.items(), key=lambda item: item[0])
print('2. 排序结果:', sortedParams)

# 拼接key=value
jointParams = '&'.join([f'{k}={str(v)}' for k, v in sortedParams])
print('3. 拼接结果:', jointParams)

# 计算签名
h = hmac.new(accessKeySecret.encode('utf-8'), jointParams.encode('utf-8'), digestmod=hashlib.md5)
sign = binascii.hexlify(h.digest()).decode('utf-8')
print('4. 签名参数accessSign结果:', sign)

params['accessSign'] = sign
param_str = urlencode(params)
print('5. 最终拼接结果:', param_str)

if botId:
    params["botId"] = botId
    
if vendorId:
    params["vendorId"] = vendorId

res = requests.post(url, json=params)
print('6. 获取授权结果：', res.text)

PREVIOUS 签名

NEXT 刷新访问令牌