请求访问 Token
在成功请求 YCM API 之前,应用程序必须先获取访问 Token 才能访问 API。
前提条件
在星纵统一管理平台上启用 API 功能,并获取 API 凭据。
更多信息,请参见 启用 YCM 二次开发接口 (API)。
请求 URL
POST {base_url}/dm/open_api/oauth/token
请求参数
注: 需注意,每个发送到 YCM API 的请求,其头域 (Headers) 中都需要携带 User Agent (UA)
信息,以便星纵统一管理平台能够识别你的应用并响应请求。例如:
User-Agent: OpenAPI
。请求体
参数 | 是否必填 | 类型 | 描述 |
---|---|---|---|
grant_type | 是 | String | 授权类型,此处固定为 client_credentials 。 |
client_id | 是 | String | 客户端 ID。 在 YCM 网页上获取客户端 ID。 |
client_secret | 是 | String | 客户端密钥。 在 YCM 网页上获取客户端密钥。 |
响应参数
参数 | 类型 | 描述 |
---|---|---|
access_token | String | 用于访问 YCM API 的 Token 。 |
refresh_token | String | 刷新 Token ,用于刷新访问 Token 。 |
token_type | String |
返回的 Token 类型。 对于 YCM API,这个字段的值始终是 |
expires_in | Integer | 访问 Token 的有效时长。 时间单位:秒 (s)。 |
jti | String | JWT(JSON Web Token),包含了访问 Token 和刷新 Token 的身份验证信息。 |
示例
请求示例
POST /dm/open_api/oauth/token HTTP/1.1
Host: ycm.yeastar.com
User-Agent: OpenAPI
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&client_id=kp9yyntmueXXXXXXXXX&client_secret=Z7wC807wK9zR77FCOqsVXXXXX
响应示例
HTTP/1.1 200 OK
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NzM0OSwicmVmcmVzaFZlcnNpb24iOjE2Mzg5NTcxNTJ9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjM4OTU4OTUyLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJiZjQ1YmUyYy0yOGFhLTQ3OTUtYmQ4MS03YzBjZjZiYWMxMmMiLCJjbGllbnRfaWQiOiJrcDl5eW50bXVlc3VrNWpvV3ZNa1RiQ0J4cU82TEtSaCJ9.9mADfLjFEG3iGsQlcQSBEE06D28PD8XC1poYPJv_GnM",
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NzM0OSwicmVmcmVzaFZlcnNpb24iOjE2Mzg5NTcxNTJ9LCJzY29wZSI6WyJhbGwiXSwiYXRpIjoiYmY0NWJlMmMtMjhhYS00Nzk1LWJkODEtN2MwY2Y2YmFjMTJjIiwiZXhwIjoxNjQwMjUzMTUyLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI2YjNiMzIwOC1lMjJlLTQ0NzctYTQ4Zi1mNDk3YTNjOWJmNmQiLCJjbGllbnRfaWQiOiJrcDl5eW50bXVlc3VrNWpvV3ZNa1RiQ0J4cU82TEtSaCJ9.8V47S5WVMkpUnIbEdaiYR2K2mwfkzURpltwYTtK4-i8",
"token_type": "bearer",
"expires_in": 1799,
"jti": "bf45be2c-28aa-4795-bd81-7c0cf6bac12c"
}