概览

什么是 OAuth

OAuth 2.0 是行业标准的授权协议,允许应用在 不暴露用户凭据 的前提下,安全地访问受保护资源。在百居易 OpenAPI 中,OAuth 凭据仅向经百居易审核的软件合作伙伴发放,让它们的应用能够代表房东调用 API。本节是写给这些合作伙伴的技术参考。


谁需要使用 OAuth

百居易 OpenAPI 支持两种鉴权方式:

  1. Access Token:使用 OpenAPI 的标准方式。在 百居易后台 创建 Access Token,每次请求带上即可。
  2. OAuth 2.0:仅适用于已获百居易发放 Client ID 和 Client Secret 的软件合作伙伴。

🚧

除非你已持有百居易发放的 OAuth 凭据,请使用 Access Token。


OAuth 工作流程

以下内容假定你已持有百居易发放的 Client ID 和 Client Secret。OAuth 流程通过下列几步实现安全的访问控制:

  1. 房东授权:应用引导房东走 授权流程 完成 API 授权。
  2. 换取 Access Token:应用用授权码或 refresh token 换取 Access Token,用于实际 API 请求。
  3. 调用 API:用 Access Token 调用百居易 OpenAPI。
  4. 管理 Token:按需刷新或撤销 Token 以保证安全。

让房东可以撤销授权

如果房东决定不再使用你的应用,必须能彻底解除你与该房东的关联。

提供撤销入口有两种方式:在你的应用内提供一个撤销按钮;或者引导房东到 百居易后台 自行撤销。


API 端点概览

百居易 OAuth API 主要包含以下两个端点:

1. 获取 / 刷新 Access Token

端点: /oauth/authorizations
说明: 通过 OAuth 2.0 授权码或 refresh token 获取新的 access token。

2. 撤销 / 删除 Token

端点: /oauth/revoke
说明: 撤销 access token 或 refresh token,断开应用与百居易账号的关联。