2024云ERP平台业务流程管理接口规范1

云ERP平台业务流程管理接口规范II目  次前  言 II多云管理平台功能 11范围 12规范性引用文件 13术语和定义 1私有云Privatecloud 1公有云Publiccloud 1云ERP平台CloudERPplatform 1微服务Micro-services 1业务协同Businesscollaboration 2数据交换Dataexchange 24接口方式 25接口安全 25.1JWT机制说明 25.2JWT基本流程 25.3JWT机制优势 35.4JWT安全相关 36平台服务接口 36.1登录（鉴权TOKEN接口） 36.2发起流程 46.3流程列表 56.4流程作废 76.5流程取回 86.6流程任务跟踪 86.7我的任务列表 96.8任务审批 11PAGEPAGE1云ERP平台业务流程管理接口规范1 范围本标准定义了云ERP平台业务流程管理的接口方式、接口规范。本标准适用于指导云ERP平台业务流程管理接口定义的设计、应用。2 规范性引用文件仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T37738-2019 信息技术 云计算 云服务质量评价指标YDB144-2014 云计算服务协议参考框架GB/T32400-2015信息技术云计算概览与词汇GB/T32399-2015信息技术云计算参考架构GB/T32399-2015CCRA（云计算参考架构）ISBN:1-937218-01-0SOARA（SOA参考架构）GB/T25109.3-2010企业资源计划第3部分：ERP功能构件规范GB/T25109.4-2010企业资源计划第4部分：ERP系统体系结构GB/T25109.2-2010企业资源计划第2部分：ERP基础数据GB/T25109.1-2010企业资源计划第1部分：ERP术语GB/T32393-2015信息技术工作流中间件参考模型和接口功能要求3 术语和定义GB/T32400、GB/TAAAAA-AAAA、GB/T25109.1-2010等界定的以及下列术语和定义适用于本文件。私有云Privatecloud指云计算平台仅提供给某个特定的客户使用。公有云Publiccloud指云计算平台的客户范围没有限制。云ERP平台CloudERPplatform指云环境下ERP系统运行平台，使用者可以通过电脑、手机、平板等智能终端设备接入网络访问构建在云服务器上的云ERP平台获得ERP应用的服务。。微服务Micro-services指实现机理模型算法的模块化、软件化，支撑互联网平台中的APP开发运行。业务协同Businesscollaboration指将各种业务系统纳入到统一云的ERP平台，由多个使用者实现协同与业务的关联，从而避免了劳动力重复，提高工作效率，防止业务与内部管控可能出现断裂，从而确保企业业务的正常运营。数据交换Dataexchange务数据及识别信息的信息列表。4 接口方式云ERP平台业务流程管理接口调用采用http协议，rest请求方式。5 接口安全云ERP平台业务流程管理接口安全采用Jsonwebtoken（JWT）机制，基于token的鉴权机制。5.1 JWT机制说明基于token的鉴权机制类似于http协议也是无状态的，它不需要在服务端去保留用户的认证信息或者会话信息。这就意味着基于token认证机制的应用不需要去考虑用户在哪一台服务器登录了，这就为应用的扩展提供了便利。5.2 JWT基本流程JWT基本流程如下：（1）用户使用用户名密码来请求服务器（2）服务器进行验证用户的信息（3）服务器通过验证发送给用户一个token（4）客户端存储token，并在每次请求时附送上这个token值（存在head里的参数X-Access-Token）（5）服务端验证token值，并返回数据5.3 JWT机制优势JWT机制具有如下优势：jsonJWTJAVA,JavaScript,NodeJS,PHP等很多语言都可以使用。payloadJWT可以在自身存储一些其他业务逻辑所必要的非敏感信息。（3）便于传输，JWT的构成非常简单，字节占用很小，所以它是非常便于传输的。（4）它不需要在服务端保存会话信息,所以它易于应用的扩展5.4 JWT安全相关JWT安全特别注意：（1）不应该在JWT的payload部分存放敏感信息，因为该部分是客户端可解密的部分。（2）保护好secret私钥，该私钥非常重要。（3）如果可以，请使用https协议。6 平台服务接口6.1 登录（鉴权TOKEN接口）6.1.1 接口描述根据用户名密码进行登录操作，通过鉴权接口，使用用户名密码获取token。6.1.2 访问地址http://域名/sys/login6.1.3 访问方式POST6.1.4 请求参数参数名数据类型是否必须示例值默认值描述usernameString是admin用户名PasswordString是123456密码6.1.5 响应参数参数名父节点数据类型描述successBooleancodeString服务器异常；510：访问权限认证未通过messageString返回处理消息timestampLong时间戳resultObject响应数据tokenresultString鉴权tokenmulti_departresultint用户所属部门数量userInforesultObject用户信息departsresultArray用户所属部门信息6.2 发起流程6.2.1 接口描述针对在线表单，自定义开发提交流程接口。6.2.2 访问地址http://域名/process/extActProcess/startMutilProcess6.2.3 访问方式POST6.2.4 请求参数参数名数据类型是否必须示例值默认值描述idString345660816d7263e2016d72f288743567表 单业务数据iddeflowCoString1dev_material_input_00流业务关配置唯编码程联一lformUrStringmaterial/modules/MaterialInputForm流审批时程附外部表单：支持http开头的外部表单地址件页面默认展示的PC端表单组件URL地址formUrlMobileStringmaterial/modules/MaterialInputForm外部表单：支持http开头的外部表单地址流 程审批时附件页面默认展示的移动端表单组件URL地址jsonDataString{name:”jeck”}Json串，额外扩展的流程变量值6.2.5 响应参数参数名父节点数据类型描述successBoolean“true”表示成功，“false”表示失败codeString返回编码。0：成功；200：成功；500：服务器异常；510：访问权限认证未通过messageString返回处理消息，如“流程发起成功！”timestampLong时间戳resultObject响应数据，流程实例ID响应示例:{"success":true,"message":"流程发起成功！","code":0,"result":"767509","timestamp":1652426536451}6.3 流程列表6.3.1 接口描述根据登录用户获取我发起的流程列表。6.3.2 访问地址http://域名/ack/task/myApplyProcessList6.3.3 访问方式GET6.3.4 请求参数参数名数据类型是否必须示例值默认值描述processDefinitinoIdStringprocess1552899184614:1:310008流 程编号columnStringcreateTime默 认排序字段orderStringdesc排 序规则pageNoint是1当 前页数pageSizeint是10每 页返回条数finishedStateQueryString是isUnFinished未完成IsFinished已完成流 程状态_tlong2452651486时 间戳6.3.5 响应参数参数名父节点数据类型描述successBoolean“true”表示成功，“false”表示失败codeString权限认证未通过messageString返回处理消息，如“操作成功！”。timestampLong时间戳resultObject响应数据totalresultLong总条数：当前共有多少流程sizeresultLong每页返回条数currentresultLong当前页号pagesresultLong当前分页总页数searchCountresultboolean进行count查询true是/false否【默认：true】recordsresultArray程）idrecordsString流程实例IDprocessInstanceIdrecordsString流程实例IDprocessDefinitionIdrecordsString流程IDprocessDefinitionNamerecordsString流程名称，如“请假申请”startUserIdrecordsString流程发起人ID，如“admin”assigneerecordsString流程负责人startTimerecordsDate流程开始时间endTimerecordsDate流程结束时间deleteReasonrecordsString流程处理结果spendTimesrecordsString流程耗时bpmBizTitlerecordsString业务标题，如“请假单”6.4 流程作废6.4.1 接口描述流程作废后单据状态为作废状态，不能在重新发起流程。6.4.2 访问地址http://域名/act/task/invalidProcess6.4.3 访问方式PUT6.4.4 请求参数参数名数据类型是否必须示例值默认值描述processInstanceIdString是347577流 程示例id6.4.5 响应参数参数名父节点数据类型描述successBoolean示失败codeString返回编码。0：成功；200：成功；500：服务器异常；510：访问权限认证未通过messageLong时间戳resultObject响应数据6.5 流程取回6.5.1 接口描述我发起的流程取回操作，流程取回后单据状态为待提交状态，可重新发起流程。6.5.2 访问地址http://域名/act/task/callBackProcess6.5.3 访问方式PUT6.5.4 请求参数参数名数据类型是否必须示例值默认值描述processInstanceIdString是347577流 程示例id6.5.5 响应参数参数名父节点数据类型描述successBoolean示失败codeString返回编码。0：成功；200：成功；500：服务器异常；510：访问权限认证未通过messageString返回处理消息timestampLong时间戳resultObject响应数据6.6 流程任务跟踪6.6.1 接口描述根据流程实例ID获取流程任务跟踪历史列表。6.6.2 访问地址http://域名/act/task/processHistoryList6.6.3 访问方式GET6.6.4 请求参数PAGEPAGE9参数名数据类型是否必须示例值默认值描述processInstanceIdString是流程实例ID_tlong1560928599时间戳6.6.5 响应参数参数名父节点数据类型描述successBoolean“true”表示成功，“false”表示失败codeString权限认证未通过messageString返回处理消息，如“操作成功！”。timestampLong时间戳resultObject响应数据totalresultLong总条数：当前流程任务数sizeresultLong每页返回条数currentresultLong当前页号pagesresultLong当前分页总页数searchCountresultboolean进行count查询true是/false否【默认：true】recordsresultArray程）idrecordsString任务idnamerecordsString任务名称assigneerecordsString任务办理人startTimerecordsDate任务开始时间endTimerecordsDate任务结束时间taskDueTimerecordsLong任务耗时processDefinitionIdrecordsString流程ID（任务都属于某个流程）processDefinitionNamerecordsString流程名称processInstacnceIdrecordsString流程实例IDbpmBizTitlerecordsString业务标题deleteReasonrecordsString任务处理结果6.7 我的任务列表PAGEPAGE106.7.1 接口描述根据登录用户获取待我审批任务列表（我的任务列表）。6.7.2 访问地址http://域名/act/task/list6.7.3 访问方式GET6.7.4 请求参数参数名数据类型是否必须示例值默认值描述processDefinitinoIdStringprocess1552899184614:1:310008流 程编号userNameStringadmin任 务发起人columnStringcreateTime默 认排序字段orderStringdesc排 序规则pageNoint是1当 前页数pageSizeint是10每 页返回条数_tlong2452651486时 间戳6.7.5 响应参数参数名父节点数据类型描述successBoolean“true”表示成功，“false”表示失败codeString返回编码。0：成功；200：成功；500：服务器异常；510：访问权限认证未通过messageString返回处理消息，如“操作成功！”。timestampLong时间戳resultObject响应数据totalresultLong总条数：当前共有多少任务sizeresultLong每页返回条数currentresultLong当前页号pagesresultLong当前分页总页数searchCountresultboolean进行count查询true是/false否【默认：true】recordsresultArray任务数组（任务都属于某个流程）idrecordsString任务idtaskIdrecordsString任务定义keytaskNamerecordsString任务名称taskAssigneeIdrecordsString任务办理人IDtaskAssigneeNamerecordsString任务办理人名称taskBeginTimerecordsDate任务开始时间taskEndTimerecordsDate任务结束时间taskDueTimerecordsLong任务耗时taskUrgerecordsBoolean任务是否催办taskUrgeRemarkrecordsBoolean任务催办备注信息processDefinitionIdrecordsString流程ID（任务都属于某个流程）processDefinitionNamerecordsString流程名称processInstacnceIdrecordsString流程实例IDprocessApplyUserIdrec