Skip to content

能力对接基础概念

API调用流程

点击查看API调用流程

WPS 业务 JSSDK

SaaS-JSSDK是WPS面向ISV第三方企业应用开发者提供的前端网页开发工具包,提供包括但不限于:调起WPS支付框、邀请成员、埋点上报等,SDK对接文档(点击查看)

事件通知

应用可通过订阅WPS开放平台提供的应用事件,实时获取并响应WPS 365里的动作。

提示

💡 事件消息体为加密后的消息体,需根据WPS开放平台提供的解密算法(点击查看)进行解密得到消息内容

API凭证

WPS开放平台提供的第三方企业应用调用企业内数据的接口验证凭证,请ISV研发优先接入API凭证。

  • 凭证类型

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

凭证类型凭证说明对接注意事项
第三方应用授权凭证

使用该凭证,应用可以访问应用自身相关的信息,不归属到具体的企业或者用户。应用授权凭证说明文档(点击查看)

相关事件:

【获取app_ticket】事件:开放平台每隔一段时间(不定期)会推送一次最新 app_ticket

【应用授权变更】事件:当企业安装应用、卸载应用、企业管理员启用应用、企业管理员禁用应用时触发消息

  • 关于app_ticket

    1. 建议在应用服务初始化时主动调用 推送 app_ticket 接口激活app_ticket的推送

    2. 监听【获取app_ticket】事件,开放平台每隔一段时间(不定期)会推送一次最新 app_ticket,需要用到app_token时,用最新的 app_ticket 获取app_token即可。

    3. app_ticket 在下次推送前,一直有效,可以多次使用,开发者使用时可不关注 ticket 的有效期。

    4. 若【推送app_ticket】事件连续 5 次未被应用响应或响应错误,平台将停止推送,应用需重新调用接口 推送 app_ticket再次激活事件推送。

  • 关于应用授权变更

    • WPS 租户企业安装或更新应用版本时,触发上述应用授权状态变更事件。应用需正常响应并持久化保存 company_id

    • 使用app_ticket和company_id调用 获取三方应用的租户 access_token 获取应用授权凭证。

    • 应用安装时会携带安装者userid,建议将安装者设置为应用的管理员

用户授权凭证:

access_token

OAuth2.0方式实现单点登录,应用使用该凭证可以获取用户基本信息。用户授权凭证说明文档 (此文档与WPS开放平台文档有所差异,以本文档为准)
  1. 用户授权作为WPS账号单点登录,在进入应用时都需要通过这种方式确认当前登录用户。

  2. code作为换取access_token的票据,每次用户授权code和access_token都是全新的。code仅可使用一次且10分钟未被使用自动过期。

  • 凭证获取顺序
PPVGYMAZAAAGCSC2VIBIA4E
第三方应用授权时序用户授权时序