工作流对外发布 API

用户5076

用户1272

用户2520

用户4286

用户7477

4月15日修改

💡

工作流 API 用来干什么？

毕昇工作流 API 可以让您在自己的平台或前端应用中，调用并执行毕昇平台上已配置好的工作流。​

毕昇工作流 API 的特点

1.
有状态：由于毕昇工作流的特点（例如支持成环、支持在任意中间过程执行输入节点从而产生中断），所以后端需要根据工作流当前状态对请求做不同响应。这意味着：同一个接口，因当前所处的工作流阶段不同，可能返回不同的数据和事件类型。​

2.
事件驱动：工作流的每一步执行都对应一个或多个事件（event）。调用者需要根据事件类型判断当前该做什么操作（渲染表单、对话框、下载文件，或者直接展示文本、图片等）。​

3.
保持上下文：在每次请求时携带 session_id，后端才能知道当前工作流进行到哪一步。如果漏掉或用错 session_id，将无法继续执行流程。​

因此：对接工作流 API 时，调用方需要仔细处理返回的事件类型，并且在后续请求提交输入时携带正确的上下文（session_id、node_id 等）。​

一、接口基本信息

1.
工作流请求执行接口​
◦
POST 方式​
◦
URL: http://<HOST>:<PORT>/api/v2/workflow/invoke​

2.
工作流停止运行接口​
◦
POST 方式 ​
◦
URL: http://<HOST>:<PORT>/api/v2/workflow/stop​

3.
处理工作流对话框上传文件接口​
a.
POST 方式​
URL：http://<HOST>:<PORT>/api/v2/workflow/input/file​

注意： <HOST> 和 <PORT> 需根据您部署的环境填写（例如 192.168.106.120:3002）。​

apifox 接口文档详见下方：

common.docs_name - LarkCCM_Docs_Menu_Image

二、整体调用流程

画板

如时序图所示，在对接工作流 API 时，一般会经历以下步骤：​

1.
第一步：发起工作流执行。通过/invoke 接口让工作流从开始节点开始运行：​

代码块

import requests​
import json​
​
url = "http://192.168.106.120:3002/api/v2/workflow/invoke"​
​
payload = json.dumps({​
   "workflow_id": "7481368b-dd1c-43ef-a254-dce219ee53e8",​
   "stream": False, # 为空或者不传，都会请求流式返回工作流事件。本示例为了直观展示返回结果，所以改为非流式请求，真实场景下为了用户体验建议请求流式。​
})​
​
headers = {​
   'Content-Type': 'application/json'​
}​
​
response = requests.request("POST", url, headers=headers, data=payload)​
​
print(response.text)# 输出工作流的响应​

工作流对外发布 API​

工作流对外发布 API