主题
插件开发上架流程
如果您是第一次在开放平台开发插件,那么请您务必仔细阅读本节的内容。在本节中,我们将详细介绍从插件创建到其最终上架的完整流程,一步一步带您了解插件各版本之间的流转过程以及它们之间的异同点。
如果您已经开发过插件并成功上架,可以选择跳过此节,在后续开发中遇到不清楚的地方时再回来查阅相关说明。
要求
在申请上架您的插件之前,请务必已满足以下要求。若您的插件不满足或者与我们的初衷背道而驰,您的上架申请将不会被我们通过。
围绕文档进行开发
您的插件必须围绕文档进行开发,这是您开发插件的最基本要素。金山文档开发平台其本质就是办公与文档场景的发散,您开发的插件它应该像是一座桥梁,以文档为基座,向其它领域渗透。
提供优秀的体验
打铁还需自身硬,优秀的产品需要完备的设计和良好的交互,它能够帮助您从众多竞品中脱颖而出。插件理论上应该是最小化的,即能够在插件内完成您的主体需求。它也应该拥有简单明了的新手引导,让用户能够轻松的完成从文档到您插件产品的过渡,以及文档在您的插件加持下,会给用户本身带来怎样的价值。
集成插件免登流程
如果的插件需要使用到服务端的Open API且有自身的用户服务,那么您需要集成开放平台插件体系的免登流程。它能显著提升您的插件的体验,打通双边的用户信息。
隐私和数据安全
您的插件不应该在任何场景下要求用户输入用户名、密码、联系方式等私密信息。如果确实需要某些用户信息,必须要经过用户明确的授权才行。
开发上架流程图
在插件从创建到上架的整个生命周期中,包含了 ISV 开发者、开发者后台和 WebOffice 文档这三部分,流程以插件创建开始,历经功能开发、提交开发版、提交审核版、到审核通过并发布上架结束。
开发上架步骤
完成服务商入驻
要在金山文档开放平台进行插件开发,您需要先成为金山文档的注册用户。注册完成后,您可以进行服务商入驻。
创建插件
当您的企业获得 ISV(服务商)资质后,便可以在开发者后台创建插件。详细的创建步骤请参考创建插件。
插件开发
在开发者后台创建好您的插件后,就可以着手进行插件的开发了。详情请参考插件开发。
提交开发版
插件项目开发完成后,将您的整个项目压缩成 zip 包,压缩包内至少包含一个插件入口文件index.html
,并处于压缩包的根路径下。
如果您的插件项目需要用到其他静态资源,比如js
、css
和image
,可以直接以相对路径的形式放置在压缩包内。
进入目标插件详情页后,在插件版本信息栏中点击新建版本,您需要如实填写好目标插件的版本号、展示方式、以及需要使用到的文件类型,然后上传您的压缩包,点击新建版本即可。
进入金山文档首页,根据插件版本中配置的组件类型,找到对应类型的文档并打开,点击扩展插件
即可看到您上传的插件开发版本。
设为体验版
上述步骤针对的均是开发版本,如果您的插件开发完成,那么可以设置某个开发版本为体验版,让测试和产品同学投入进来进行完整的测试和体验。
注意
一个插件只能有一个体验版,新设置的体验版会将原来的版本覆盖掉,您可在多个开发版之间任意切换体验版,最终结果保留为最后一次设置的体验版。
提交审核
如果您的插件通过了测试,那么便可以选择发布至线上环境,为真实的用户提供插件服务。
进入开发者后台,进入目标插件的版本信息 Tab 页,选择对应的插件开发版本,点击提交审核
按钮即可。至此,插件开发流程告一段落,您只需静候我们的审核结果。
发布线上
在您提交审核后,我们将在三个工作日内完成对您插件的审核。在此期间,您可以进入开发者后台,在目标插件的审核版本栏中查看审核状态。
若审核不通过,我们会在审核详情中告知您不通过的原因,以便您能对症下药快速修复问题。
若审核通过,我们会择期把您的插件发布至线上环境,到时所有用户便可以直接通过外网使用到您开发的插件了。
注意
一个插件只能有一个线上版,注意新发布的插件会将原来的版本覆盖掉。