本文内容

API 凭证概述

应用调用服务端 API,需要从WPS协作开放平台获取相应的访问凭证(access token);访问凭证代表应用从平台、企业、用户手中获得的授权。

WPS协作开放平台访问凭证分为 3 类:

  • access_token:用户授权凭证。使用该凭证,应用将代表用户执行对应的操作,比如通过 API 创建一个日程。
  • app_token:应用授权凭证。使用该凭证,应用可以访问应用自身相关的信息,不归属到具体的企业或者用户,比如获取当前登录应用的用户身份。
  • company_token:企业授权凭证。使用该凭证,应用将代表企业或者团队执行对应的操作,比如获取一个通讯录用户的信息。

如何使用访问凭证

不同的 API 会支持上述一种或多种的访问凭证作为 API 调用时的鉴权手段。

API 调用时,需要将凭证放入请求参数中,如下 API 请求所示。注意的是,示例中的 "COMPANY_TOKEN" 需要替换为有效的访问凭证:

[POST] https://openapi.wps.cn/plus/v1/company/depts?company_token=COMPANY_TOKEN

选择合适的访问凭证

不同的访问凭证代表了不同的资源访问权限,调用同一个 api,使用不同的凭证将会获取不同的数据。

需要根据应用场景来选择合适的 API 访问凭证,以下是不同的 API 访问凭证在主要场景下的区别。

访问凭证类型 是否需要用户授权 是否需要企业管理员授权 适用的应用场景
access_token 需要 不需要 网页应用
company_token 不需要 需要 网页应用、机器人
app_token 不需要 不需要 纯后台、文档权限等
本文内容