授权规则

YCM API 采用 OAuth 2.0 协议进行认证和授权。本文介绍了 API 的授权流程和 Token 到期时间。

授权流程

以下内容介绍了应用程序通过 OAuth 2.0 协议访问 YCM API 的流程。
1. 启用 YCM API
你需要在星纵统一管理平台（YCM）上启用 API 功能，获取客户端 ID 和客户端密钥。更多信息，请参见 启用 YCM 二次开发接口 (API)。
2. 获取访问 Token
使用客户端 ID 和客户端密钥从 Yeastar 授权服务器上获取访问 Token，允许你的应用程序访问 YCM API。更多信息，请参见 请求访问 Token。
3. 携带访问 Token 发起 API 请求
获取访问 Token 后，你需要在 HTTP 请求头中添加访问 Token ，这样一来，授权服务器就会允许你的应用程序发起 REST API 请求。
4. 如有需要，刷新访问 Token

访问 Token 有效时长为 30 分钟。如果你的应用程序在 30 分钟后仍需访问 YCM API，你需要请求刷新 Token ，获取新的访问 Token。更多信息，请参见 刷新访问 Token。

Token 过期时间

访问 Token 的有效时长为 30 分钟。

刷新 Token 的有效时长为 15 天。如果刷新 Token 失效，可能有以下几项原因：

  • 刷新 Token 被撤销。
  • 刷新 Token 的时间已超过 15 天。
  • 在 YCM 网页上重新生成了新的 客户端密钥。