插件开发指南

金山文档开放平台插件，本质其实是一个运行在文档内的“网页应用”，我们在这个“网页应用”里提供了丰富的 API 帮助您轻松而快捷的和载体文档进行交互。

有了这层理解，那么开发插件实际上就是开发一个网页，您可以使用任意前端技术栈完成您的界面开发。通过集成我们的插件 SDK，可以对本插件进行全方位的定制和操作，也可以直接调用 SDK 接口与载体文档进行交互。当然，您的插件后台也能通过调用服务端的Open API完成用户信息和文档信息的增删改查。

前言

在准备好进行插件开发之前，可以先集成插件开发工具，以便能顺利对您的插件进行调试和运行。

插件 SDK是插件框架提供的一个 JavaScript 库，由前端开发者手动引入到您的插件中。它是开发者需要重点关注的内容，是您的插件与“外界”沟通的桥梁。尽量先去熟悉它的各项能力，对您实际的业务开发有事半功倍的效果。

如果您的产品需要与文档用户关联，或者需要批量创建/更新文档、提取文档内容以及转换文档格式等任务时，那么开放平台的Open API也是您需要详细了解的内容。它内部提供了一套完善的基于OAuth 2.0的授权体系，丰富的文档操作接口和Webhook订阅。

注意

区别于插件 SDK，Open API只能由服务端去调用。

开始开发

开发者需要在本地新建一个 index.html 文件作为插件的根页面，您可以选择合适的技术栈进行界面开发，结合自身业务，灵活实现插件的各项功能。

<!--index.html -->

<html>
  <head>
    <!-- 此处可引入插件SDK，通过SDK您可以方便的调用API -->
  </head>

  <body>
    <h1>第一个插件</h1>
  </body>

  <script></script>
</html>

项目开发完成后，将您的项目打包成 xxx.zip 压缩包，压缩包内至少包含一个插件入口文件index.html，并处于压缩包的根路径下。

有了插件压缩包后，您可以进入开发者后台上传开发版本的插件，在集成环境中进行插件的开发和调试。

插件开发指南 #

前言 #

开始开发 #

插件开发指南

前言

开始开发