
子流程API功能介绍
集简云目前已经接入了超过10,000个软件接口与功能,如何将这些功能添加到您自己的系统中使用呢?集简云为开发者提供了一种简单的方式:子流程API调用。
子流程的完整API文档已经迁移至我们的开发者接口文档页面,见 https://apifox.com/apidoc/project-1422646/doc-1979991?nav=1
比如:您可以在集简云系统的百度OCR功能做图片识别,并将识别后的文字按照您的自定义格式返回到您的系统中。
简而言之,您可以将集简云的流程封装成一个接口,通过API调用执行。
如何使用子流程API功能?
整体分为两个部分:
● 创建一个子流程
● 使用API接口进行调用
我们分开进行说明:
如何创建一个子流程?
1 首先,登录您的集简云账户,创建流程:
https://apps.jijyun.cn/data-pipeline/create
2 在步骤1,选择子流程,启动子流程动作
3 设置输入字段和示例参数,这些字段将在API接口中作为传入参数
● 在输入变量位置,左侧为字段key,也就是后续API接口传入的字段key。
● 右侧为字段key对应的参数,手动输入示例参数用于流程创建,后续执行时使用的是API接口实际的传入入参数。
● 点击“+”加号,可以添加多个字段key。
点击发送数据配置样本:
4 配置执行步骤:
下面您可以按照您的需求添加一个或者多个执行动作,比如百度OCR图片识别,MySQL数据查询,企业微信消息通知等等.....
在配置过程中可以使用步骤1配置的字段和示例字段值做配置流程。
5 自定义返回参数
下面我们来设置接口返回的参数和格式,也就是您发起API调用后,接口返回的参数:
左侧为返回的字段Key,中间为字段格式,右侧为返回的字段值
在返回的字段值中,您可以将前面步骤中的参数作为变量插入,也可以写入固定值,或者变量与固定值混合使用。
好的,我们配置完毕了子流程,下面我们介绍如何通过API接口调用这个流程。
如何通过API接口调用子流程?
我们提供了完整的API接口文档,您可以查看这里:查看接口文档 下面我们来带你一步步进行操作。
1 获取您的API接口权限
登录集简云开放平台的嵌入方案页面:集简云-开发者平台 (https://open.jijyun.cn/embed/apicfg)
● 获取您的corp_id与secrect
● 可以设置IP白名单,增加安全性
2 调用接口获取授权凭证(Token)
接口文档:https://www.apifox.cn/apidoc/project-1422646/api-64021726?nav=1
凭证的有效期为2个小时。使用此凭证调用后续动作。
3 调用子流程执行接口
接口文档:https://www.apifox.cn/apidoc/project-1422646/api-51708596?nav=1
其中process_id为流程ID,可在流程列表中查看:
data下面的传入字段key是您子流程步骤1中设置的参数:
发送请求后获取的返回参数为您配置的返回参数:
如果需要调整,可与随时需修改流程,在保存即可生效。
通过这种方式,您可与非常简单的调用集简云对接的全部应用和动作,并且支持调用多个不同的应用后合并返回参数。
了解更多集简云嵌入方案
子流程的API调用方式适用于为您自己的内部系统中快速添加集成对接能力。
如果您希望将此能力给您的客户使用,我们建议您使用 “SDK页面嵌入”方案。更新信息,可查看我们的文档: https://www.apifox.cn/apidoc/project-1422646/doc-1979974?nav=1