获取访问令牌
访问令牌是使用融云控制台 SDK 的必要凭证。本文档详细介绍如何获取和管理访问令牌。
接口地址
API 地址: https://embed-console.rongcloud.net/embed/access/token
请求方法: POST
Content-Type: application/json
请求参数
参数名 | 类型 | 必传 | 说明 |
---|---|---|---|
access_key | string | 是 | 融云应用的 Access Key |
page_code | string | 是 | 页面代码,指定要嵌入的控制台页面。关于可用的页面代码及其说明,请参考准备工作文档中的详细列表。 |
useful_life | number | 是 | 令牌有效期,单位:秒。取值范围: 1-31536000。 注意: 令牌有效期过短会增加刷新频率,过长则存在安全风险。建议根据实际使用场景选择合适的时长。 |
请求示例
- cURL
- JavaScript
bash
curl --location --request POST 'https://embed-console.rongcloud.net/embed/access/token' \
--header 'Content-Type: application/json' \
--data-raw '{
"access_key": "YOUR_ACCESS_KEY",
"page_code": "user_manage",
"useful_life": 36000
}'
javascript
// 基础请求函数
async function getAccessToken(accessKey, pageCode, usefulLife = 36000) {
const apiUrl = 'https://embed-console.rongcloud.net/embed/access/token';
try {
const response = await fetch(apiUrl, {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
access_key: accessKey,
page_code: pageCode,
useful_life: usefulLife
})
});
if (!response.ok) {
throw new Error(`HTTP ${response.status}: ${response.statusText}`);
}
const result = await response.json();
if (result.code === 10000 && result.data) {
return result.data;
} else {
throw new Error(result.message || '获取访问令牌失败');
}
} catch (error) {
console.error('获取访问令牌失败:', error);
throw error;
}
}
// 使用示例
getAccessToken('YOUR_ACCESS_KEY', 'user_manage', 36000)
.then(tokenUrl => {
console.log('获取到访问令牌 URL:', tokenUrl);
// 使用 tokenUrl 初始化控制台
})
.catch(error => {
console.error('错误:', error.message);
});
JSON 数据格式
JSON
{
"access_key": "YOUR_ACCESS_KEY",
"page_code": "user_manage",
"useful_life": 36000
}
响应格式
成功响应
JSON
{
"code": 10000,
"data": "https://embed-console.rongcloud.net/agile/embed?page_code=user_manage&access_token=...",
"expire": 1754916283575,
"access_id": "7360491030918791188"
}
响应参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | number |