Skip to content

插件 Open API

插件后台业务的开发,离不开对Open API的调用。区别于插件 SDK 与插件前端强绑定,Open API是专门为后台开发者提供的。你可以先尝试浏览下API 总览,了解开发平台为不同组件提供的各项基础能力。

在您准备使用接口之前,你应该先对如下概念有基础的认识:

  • 权限:权限决定了您的插件可以使用开放平台Open API提供的哪些能力,比如哪些接口可用,哪些参数可以生效,哪些资源可以访问等。您在开发者后台创建插件时,我们会要求您确定好插件需要用到的权限,在用户进行插件授权时,我们会显示这些权限信息,让用户自由确定是否进行授权。金山文档开放平台构建了一套完善的插件权限体系,保证各业务方信息的安全。
  • 限频:限频决定了您的插件在一定时间段内使用接口的次数。目前我们采用的是单接口、单日限额的方式。注意不同类型的接口,单日限额不同。
  • 通用参数:通用参数是指大多数 Open API 都会用到的参数,比如与插件相关的参数 app_id、令牌相关的参数 access_token、文档相关的参数open_idunion_id。在使用接口时,可以先去了解一下这些通用参数所代表的含义。
  • 授权流程:创建插件时,需要您填写插件需要用到的权限。在用户第一次打开插件时自动打开授权弹窗,点击确定后会将授权码传递至插件内部,您可以通过插件框架提供的接口获取该授权码,完成后续的OAuth 认证流程,获取到令牌以及用户信息。