集简云教学 数据表教学 应用教学 开放平台 用户社区 语聚AI
打开导航
首页 > 开放平台 > 集简云嵌入方案 > 子流程使用方法与接口文档
子流程使用方法与接口文档
开发者可以通过接口的方式调用在集简云中已经嵌入的子流程。

子流程接口使用方式介绍

 

开发者可以通过接口的方式调用在集简云中已经嵌入的子流程。

 

子流程调用完整API文档已迁移至我们独立的开发者接口文档页面,见:https://apifox.com/apidoc/project-1422646/doc-1979991?nav=1

 

例如:您可以通过集简云子流程搭建一个业务流程,包括请求参数(子流程步骤1中设置),和流程返回参数(子流程中最后一个步骤选择),具体步骤如下:

1 进入集简云搭建一个流程:https://apps.jijyun.cn/data-pipeline/create

2 步骤1选择: 子流程应用下的启动流程动作



 

3 配置请求参数,此参数将用于启动子流程的接口时的请求参数:



 

4 配置后续流程步骤,依据您的需要选择数据同步到的应用和动作, 例如:



 

5 再次选择”子流程”应用作为最后一个步骤,选择”返回流程“



 

在这个步骤中设置返回参数,也就是接口调用成功后返回的Response。



 

您可以将前面各个步骤中返回的参数作为字段值,插入到返回参数中,每次接口请求后将自动运行此流程,并返回您设置的参数key和参数值。



子流程接口调用步骤说明:

 

您可以按照以下步骤调用子流程接口:

调用子流程列表接口,获取当前企业下可用子流程列表ID以及流程详情(包括子流程启动时需要输入的参数)

调用子流程运行接口,传递启动子流程的参数,将指定数据推送到子流程并启动。执行完毕后会按照您在子流程配置中”返回流程”步骤配置的参数作为返回参数

注意:每个流程步骤执行大概会在1-2秒完成,取决于您调用的应用接口返回速度,因此建议将接口等待返回时间设置长一些,比如如果您的子流程有5个步骤,我们建议您的等待接口返回时间设置不少于10秒。

 

如何获取API接口授权

 

进入开发者平台在 嵌入方案-API权限管理 页面获取corp_id和secret两个参数



 

子流程列表接口

 

POST    https://openapi.jijyun.cn/v1/api/query_process

使用开发者平台提供的API授权信息请求此接口查询子流程列表

 

请求参数

Body Parameters

 

 

返回结果

200: OK

 

子流程运行接口

请求参数

Body Parameters

 

返回结果

200: OK

 

本篇目录
  • 子流程接口使用方式介绍
  • 子流程接口调用步骤说明:
  • 如何获取API接口授权
  • 子流程列表接口
  • 请求参数
  • 返回结果
  • 子流程运行接口
  • 请求参数
  • 返回结果