授权规则

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

授权流程

第三方应用访问 Yeastar P 系列 IPPBX API 的流程如下所示:

  1. 第三方应用发送凭证进行认证,以申请访问 token

    第三方应用从 PBX 网页上 (路径应用对接 > 二次开发接口) 获取 客户端 ID客户端密钥 后,发送此凭证来 请求一个访问 token

  2. PBX 提供一个访问 token

    PBX 校验客户端 ID 和客户端密钥,并返回一个访问 token。

  3. 第三方应用携带访问 token 调用 API 接口

    第三方应用发送携带了访问 token 的 API 请求,进行 API 调用。

  4. PBX 提供请求的资源

    PBX 验证访问 token 的有效性,并返回请求的数据。

  5. 如有需要,刷新访问 token

    访问 token 有效时长为 30 分钟。你可以 刷新访问 token 以获取新的访问 token 来进行 API 调用。

Token 过期时间

访问 token (access token) 的有效时长为 30 分钟,而刷新 token (refresh token) 的有效时长为 24 小时。第三方应用可使用 刷新访问 Token 接口来更新访问 token 和刷新 token,也可以使用 获取访问 Token 接口获取新的访问 token 和刷新 token。