在集简云开放平台进行应用开发大致需要以下步骤:
- 创建应用并填写应用信息
- 设置应用授权方式
- 添加触发动作/执行动作
- 测试并发布
- 设置样本数据与字段Key的中文转译 (全网发布时必要步骤)
- 配置流程模板 (全网发布时必要步骤)
- 版本更新(如接口有变化时)
创建应用并填写应用信息:
创建应用
每个新入驻的应用软件都从创建应用开始。集简云集成了数百款应用软件,并且还在不断增加。为了帮助用户从众多产品中迅速找到您的应用软件,我们设置了清晰的描述和徽标,并挑选应用软件使用类别,新用户可能会在搜索产品时快速发现您的应用。
以下是所需每个内容的具体说明:
应用名称
添加您的应用程序的真实名称,不要包含商标或版权符号。
应用描述
包含最多140个字符的应用程序核心功能和用例描述,例如“Trello是一种团队协作工具,用于在桌面上组建任务并保持项目正常进行。” 不要包含夸大其词的修饰词,例如“最受欢迎”、“最佳”,也不要包含链接或格式。
应用主页
添加您公司的企业官网,或该应用程序的介绍详情页面。
应用图标
上传产品应用图标Logo。图标为透明的PNG文件,尺寸为256x256像素(如果可用,请使用更大的图像,但不要超过 2048x2048 像素)。如果您的图标使用纯色背景,请把圆角宽度调整 3%,并使其背景透明。不要在图标Logo中包含您的应用软件名称。
全部填写后,点击“创建”,即可开始应用编辑
添加接口授权方式
接口授权方式代表您的接口通过那种方式授权并验证用户是否有接口使用权限,目前集简云开放平台支持的授权方式包括:
- API Key
- Basic Auth
- OAuth2.0
- Session Auth
- Digest Auth
关于授权方式的选择和使用,可以见文档:如何选择应用授权方式?
设置用户需要填写的字段:
设置验证权限接口参数:
配置完成后可以通过集简云提供的添加账号验证操作,校验发送的参数与返回参数是否正确:
更多授权设置,见应用授权配置文档:
添加触发与执行动作
每个应用至少应该包含一个动作,动作分为触发动作与执行动作:
- 触发动作:仅在流程的第一个步骤使用,由于触发流程。例如:当数据新增时,或者当数据修改时;
- 执行动作:在流程第二个步骤和后续步骤中使用,例如 添加数据,修改数据,查询数据等;
关于触发动作和执行动作的添加我们会在相关文档中介绍。
测试及发布
您在应用开发中的修改是实时生效的(点击保存按钮后),您可以直接在您的企业下使用此应用创建流程并进行测试,但是如果您要发布到全网可见,则需要通过集简云开放平台的审核,具体审核流程可以在沟通群里咨询。
设置样本和字段中文转译
设置触发动作样本可以让用户更简单的使用您的应用(仅针对实时触发类型动作需要配置)
字段Key中文转译:为了方便用户看懂您的应用返回字段Key的含义,您可以在开放平台配置Key对应的样本和参数说明便于用户使用。
详情可见相关文档。
配置流程模板
流程模板可以快速帮助用户使用您的应用产品搭建流程,如果您的应用要设置为全网可见,我们建议您配置不少于5个流程模板,开发者平台的流程模板配置方式与流程分享方式一样,可见:流程分享功能帮助说明
应用开发示例
我们为开发者准备了应用开发示例,以便参考:
应用开发示例1:百度云OCR