开发者中心

# OpenAPI发起流程

# 一、OpenAPI接口查看方法

  1. 启动BPM服务后，在控制台获取OpenAPI地址：
    https://localhost:6001/OpenAPI
  2. 在浏览器打开该地址，查找"发起流程"接口：
    /v1/workflow/process/{processId}/version/{version}/start

# 二、接口参数说明

参数位置 参数名 说明
URL processId 流程唯一标识符
URL version 流程版本号
Request Body actionName 流程提交线显示文字
Request Body uid 流程发起人账号
Request Body formData 表单数据(JSON格式)

# 三、获取流程ID和版本

  1. 登录BPM系统，进入"发起申请"目录

  2. 浏览器按F12打开开发者工具

  3. 点击流程列表的刷新按钮

  4. 在Network标签页多了一行数据，选中它

    • 从返回数据中找到目标流程的：
    • processId
    • version

    获取流程ID和版本

▲ 获取流程ID和版本

# 四、获取表单数据

  1. 在BPM系统手动发起目标流程

  2. 提交时在开发者工具的Network标签页：

    • 找到start请求
    • 复制Payload中的表单数据

    获取表单数据

▲ 获取表单数据

# 五、代码实现示例

# 5.1 原生OpenAPI调用

参考安装包中的演示代码：

SourceCode/Demo/OpenAPI/StartProcessInstance.cs

关键参数配置：

// 流程标识参数
string processId = "从Network获取的processId"; 
string version = "从Network获取的processVersion";

// 表单数据
var formData = new {
    // 粘贴从Payload复制的数据
};

# 5.2 .NET简化调用（使用Yiez.Client库）

参考安装包中的演示代码：

SourceCode/Demo/GrpcAPI/StartProcessInstance.cs

这是使用Yiez.Client库的实现，代码更简洁。Yiez.Client这个库是.net的，是给.net开发者使用的。

# 六、注意事项

  1. 认证信息需配置正确的访问Key
  2. Java开发者建议直接使用OpenAPI方式
  3. 表单数据结构需与流程定义严格匹配

← 信号触发流程 →