Get access token / 获取访问令牌

Purpose

Issue an OAuth 2.0 bearer access token for a system-integration account.

Execution logic

Accepts grant_type from form or query parameters; it is required and must equal client_credentials.

Authenticates the supplied client key and secret against an enabled system-integration account.

Returns an access token for that account. The current token lifetime is 7,200 seconds. This flow does not issue a refresh token.

Use the token as Authorization: Bearer <access_token> when calling the other /api/v1 endpoints. The account's assigned REST permissions still determine which endpoints it may call.

Option effects and errors

Missing grant_type returns OAuth invalid_request; another grant type returns unsupported_grant_type. Invalid client credentials return an OAuth authentication error. Do not send the client secret to business endpoints and do not place credentials in logs.

中文说明

用途

为系统集成账号签发 OAuth 2.0 Bearer 访问令牌。

执行逻辑

从表单或查询参数读取 grant_type；该字段必填且只能是 client_credentials。

使用 client key 和 client secret 认证一个已启用的系统集成账号。

为该账号返回访问令牌；当前有效期为 7,200 秒，本流程不签发 refresh token。

调用其他 /api/v1 接口时使用 Authorization: Bearer <access_token>；账号配置的 REST 权限仍决定它能调用哪些接口。

选项影响与错误

缺少 grant_type 返回 OAuth invalid_request，使用其他授权类型返回 unsupported_grant_type；客户端凭据错误返回 OAuth 认证错误。client secret 不应发送给业务接口，也不应写入日志。

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Token issued / 令牌签发成功

Bodyapplication/json

示例

{
    "access_token": "ACCESS_TOKEN",
    "expires_in": 7200,
    "token_type": "Bearer",
    "scope": "string"
}

Get access token / 获取访问令牌

Purpose

Execution logic

Option effects and errors

中文说明

用途

执行逻辑

选项影响与错误

请求参数

请求示例代码

返回响应

Get access token / 获取访问令牌

Purpose#

Execution logic#

Option effects and errors#

中文说明#

用途#

执行逻辑#

选项影响与错误#

请求参数

请求示例代码

返回响应

Purpose

Execution logic

Option effects and errors

中文说明

用途

执行逻辑

选项影响与错误