令牌端点
POST/openapi/v1/oauth/token
获取用于服务端 API 调用的访问令牌。
提交 client_id、client_secret 和目标 space_id,即可获得 Bearer 令牌。令牌有效期为 1 小时,建议缓存并在到期前约 60 秒重新申请。
请求参数
Body 请求体
application/x-www-form-urlencodedgrant_type必填string
固定值 `client_credentials`。
client_credentials
client_id必填string
应用的 `client_id`。
client_secret必填string(password)
应用的 `client_secret`。请妥善保管,切勿暴露给客户端。
space_id必填string
操作所在的 Space(租户)。应用须已安装于该 Space。
scope选填string
请求的权限范围(空格分隔)。若不填,默认使用该 Space 授予此应用的最大权限范围。
请求示例
"grant_type=client_credentials&client_id=SGCLxQk2mN8pR4vW1yH3jT5bZ6aE7cF0&client_secret=Kj3mN8pR4vW1xZ6bY2qT5hE9gA0cF7dLsUr4Qz8P&space_id=SGSPxQk2mN8pR4vW1yH3jT5bZ6aE7cF0&scope=envelope%3Acreate+envelope%3Aread"响应参数
Response.Data
access_token必填string
JWT 访问令牌,有效期 1 小时。
token_type必填string
固定值 `Bearer`。
Bearer
expires_in必填integer
访问令牌有效期(秒)。
scope选填string
实际授予的权限范围。
响应示例
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "Bearer",
"expires_in": 3600,
"scope": "envelope:create envelope:read"
}错误码
| HTTP 状态码 | 错误码 | 说明 |
|---|---|---|
| 400 | invalid_request | 缺少必要参数 |
| 400 | invalid_scope | 请求 scope 超出授权范围 |
| 400 | invalid_grant | 授权许可无效或已过期 |
| 400 | unsupported_grant_type | 不支持的 grant_type |
| 401 | invalid_client | client_secret 错误 |
| 401 | invalid_client | client_id 不存在或应用已停用 |
| 500 | server_error | 服务器内部错误。 |