AccessToken
AccessToken 是用于身份认证的安全令牌,用于访问云开发平台的受保护资源。
令牌类型
云开发平台支持三种令牌类型:
- Access_token
- API Key
- Publishable Key
- 适用环境:客户端/服务端
- 用户权限:登录用户权限
- 有效期:默认 2 小时,过期后需要使用 RefreshToken 刷新, 可以在 云开发平台/身份认证/token 进行管理
- 获取方式:通过 用户名密码登录 或 WebSDK/身份认证 获取
用户名密码登录示例:
const axios = require("axios");
let data = JSON.stringify({
username: "string",
password: "string",
});
const res = await axios.request({
url: "https://your-envId.api.tcloudbasegateway.com/auth/v1/signin",
method: "post",
data,
});
const access_token = res.data.access_token;
const refresh_token = res.data.refresh_token;
- 适用环境:服务端
- 用户权限:管理员权限
- 有效期:长期有效
- 获取方式:通过 云开发平台/ApiKey 管理页 获取
⚠️ 注意:令牌是身份认证的关键凭证,请妥善保管。ApiKey 严禁在客户端使用。
- 适用环境:客户端/服务端
- 用户权限:匿名用户权限
- 有效期:长期有效
- 获取方式:通过 云开发平台/ApiKey 管理页 获取
💡 注意:可以暴露在浏览器,用于请求公开访问的资源,可以有效降低 MAU
使用方式
在 HTTP API 调用时,将令牌添加到请求头:
Authorization: Bearer <access_token/apikey/publishable_key>
注意
实际调用时,需要将包含尖括号(< >)在内的完整部分替换为您获取到的 key。例如获取到的 key 为 eymykey,则填入方式为:
Authorization: Bearer eymykey
代码示例
HTTP 请求示例
curl -X POST "https://your-env-id.api.tcloudbasegateway.com/v1/functions/YOUR_FUNCTION_NAME" \
-H "Authorization: Bearer <access_token/apikey/publishable_key>" \
-H "Content-Type: application/json" \
-d '{
"name": "张三",
"age": 25
}'
假设从云开发平台获取到的 accesstoken 为 eymykey,环境 ID 为 cloud1-abc,调用函数名为 my-first-function,则实际请求如下:
curl -X POST "https://cloud1-abc.api.tcloudbasegateway.com/v1/functions/my-first-function" \
-H "Authorization: Bearer eymykey" \
-H "Content-Type: application/json" \
-d '{
"name": "张三",
"age": 25
}'