2024云ERP平臺(tái)業(yè)務(wù)流程管理接口規(guī)范1

云ERP平臺(tái)業(yè)務(wù)流程管理接口規(guī)范II目??次前??言 II多云管理平臺(tái)功能 11范圍 12規(guī)范性引用文件 13術(shù)語和定義 1私有云Privatecloud 1公有云Publiccloud 1云ERP平臺(tái)CloudERPplatform 1微服務(wù)Micro-services 1業(yè)務(wù)協(xié)同Businesscollaboration 2數(shù)據(jù)交換Dataexchange 24接口方式 25接口安全 25.1JWT機(jī)制說明 25.2JWT基本流程 25.3JWT機(jī)制優(yōu)勢(shì) 35.4JWT安全相關(guān) 36平臺(tái)服務(wù)接口 36.1登錄（鑒權(quán)TOKEN接口） 36.2發(fā)起流程 46.3流程列表 56.4流程作廢 76.5流程取回 86.6流程任務(wù)跟蹤 86.7我的任務(wù)列表 96.8任務(wù)審批 11PAGEPAGE1云ERP平臺(tái)業(yè)務(wù)流程管理接口規(guī)范1 范圍本標(biāo)準(zhǔn)定義了云ERP平臺(tái)業(yè)務(wù)流程管理的接口方式、接口規(guī)范。本標(biāo)準(zhǔn)適用于指導(dǎo)云ERP平臺(tái)業(yè)務(wù)流程管理接口定義的設(shè)計(jì)、應(yīng)用。2 規(guī)范性引用文件僅該日期對(duì)應(yīng)的版本適用于本文件；不注日期的引用文件，其最新版本（包括所有的修改單）適用于本文件。GB/T37738-2019 信息技術(shù) 云計(jì)算 云服務(wù)質(zhì)量評(píng)價(jià)指標(biāo)YDB144-2014 云計(jì)算服務(wù)協(xié)議參考框架GB/T32400-2015信息技術(shù)云計(jì)算概覽與詞匯GB/T32399-2015信息技術(shù)云計(jì)算參考架構(gòu)GB/T32399-2015CCRA（云計(jì)算參考架構(gòu)）ISBN:1-937218-01-0SOARA（SOA參考架構(gòu)）GB/T25109.3-2010企業(yè)資源計(jì)劃第3部分：ERP功能構(gòu)件規(guī)范GB/T25109.4-2010企業(yè)資源計(jì)劃第4部分：ERP系統(tǒng)體系結(jié)構(gòu)GB/T25109.2-2010企業(yè)資源計(jì)劃第2部分：ERP基礎(chǔ)數(shù)據(jù)GB/T25109.1-2010企業(yè)資源計(jì)劃第1部分：ERP術(shù)語GB/T32393-2015信息技術(shù)工作流中間件參考模型和接口功能要求3 術(shù)語和定義GB/T32400、GB/TAAAAA-AAAA、GB/T25109.1-2010等界定的以及下列術(shù)語和定義適用于本文件。私有云Privatecloud指云計(jì)算平臺(tái)僅提供給某個(gè)特定的客戶使用。公有云Publiccloud指云計(jì)算平臺(tái)的客戶范圍沒有限制。云ERP平臺(tái)CloudERPplatform指云環(huán)境下ERP系統(tǒng)運(yùn)行平臺(tái)，使用者可以通過電腦、手機(jī)、平板等智能終端設(shè)備接入網(wǎng)絡(luò)訪問構(gòu)建在云服務(wù)器上的云ERP平臺(tái)獲得ERP應(yīng)用的服務(wù)。。微服務(wù)Micro-services指實(shí)現(xiàn)機(jī)理模型算法的模塊化、軟件化，支撐互聯(lián)網(wǎng)平臺(tái)中的APP開發(fā)運(yùn)行。業(yè)務(wù)協(xié)同Businesscollaboration指將各種業(yè)務(wù)系統(tǒng)納入到統(tǒng)一云的ERP平臺(tái)，由多個(gè)使用者實(shí)現(xiàn)協(xié)同與業(yè)務(wù)的關(guān)聯(lián)，從而避免了勞動(dòng)力重復(fù)，提高工作效率，防止業(yè)務(wù)與內(nèi)部管控可能出現(xiàn)斷裂，從而確保企業(yè)業(yè)務(wù)的正常運(yùn)營(yíng)。數(shù)據(jù)交換Dataexchange務(wù)數(shù)據(jù)及識(shí)別信息的信息列表。4 接口方式云ERP平臺(tái)業(yè)務(wù)流程管理接口調(diào)用采用http協(xié)議，rest請(qǐng)求方式。5 接口安全云ERP平臺(tái)業(yè)務(wù)流程管理接口安全采用Jsonwebtoken（JWT）機(jī)制，基于token的鑒權(quán)機(jī)制。5.1 JWT機(jī)制說明基于token的鑒權(quán)機(jī)制類似于http協(xié)議也是無狀態(tài)的，它不需要在服務(wù)端去保留用戶的認(rèn)證信息或者會(huì)話信息。這就意味著基于token認(rèn)證機(jī)制的應(yīng)用不需要去考慮用戶在哪一臺(tái)服務(wù)器登錄了，這就為應(yīng)用的擴(kuò)展提供了便利。5.2 JWT基本流程JWT基本流程如下：（1）用戶使用用戶名密碼來請(qǐng)求服務(wù)器（2）服務(wù)器進(jìn)行驗(yàn)證用戶的信息（3）服務(wù)器通過驗(yàn)證發(fā)送給用戶一個(gè)token（4）客戶端存儲(chǔ)token，并在每次請(qǐng)求時(shí)附送上這個(gè)token值（存在head里的參數(shù)X-Access-Token）（5）服務(wù)端驗(yàn)證token值，并返回?cái)?shù)據(jù)5.3 JWT機(jī)制優(yōu)勢(shì)JWT機(jī)制具有如下優(yōu)勢(shì)：jsonJWTJAVA,JavaScript,NodeJS,PHP等很多語言都可以使用。payloadJWT可以在自身存儲(chǔ)一些其他業(yè)務(wù)邏輯所必要的非敏感信息。（3）便于傳輸，JWT的構(gòu)成非常簡(jiǎn)單，字節(jié)占用很小，所以它是非常便于傳輸?shù)?。?）它不需要在服務(wù)端保存會(huì)話信息,所以它易于應(yīng)用的擴(kuò)展5.4 JWT安全相關(guān)JWT安全特別注意：（1）不應(yīng)該在JWT的payload部分存放敏感信息，因?yàn)樵摬糠质强蛻舳丝山饷艿牟糠帧＃?）保護(hù)好secret私鑰，該私鑰非常重要。（3）如果可以，請(qǐng)使用https協(xié)議。6 平臺(tái)服務(wù)接口6.1 登錄（鑒權(quán)TOKEN接口）6.1.1 接口描述根據(jù)用戶名密碼進(jìn)行登錄操作，通過鑒權(quán)接口，使用用戶名密碼獲取token。6.1.2 訪問地址http://域名/sys/login6.1.3 訪問方式POST6.1.4 請(qǐng)求參數(shù)參數(shù)名數(shù)據(jù)類型是否必須示例值默認(rèn)值描述usernameString是admin用戶名PasswordString是123456密碼6.1.5 響應(yīng)參數(shù)參數(shù)名父節(jié)點(diǎn)數(shù)據(jù)類型描述successBooleancodeString服務(wù)器異常；510：訪問權(quán)限認(rèn)證未通過messageString返回處理消息timestampLong時(shí)間戳resultObject響應(yīng)數(shù)據(jù)tokenresultString鑒權(quán)tokenmulti_departresultint用戶所屬部門數(shù)量userInforesultObject用戶信息departsresultArray用戶所屬部門信息6.2 發(fā)起流程6.2.1 接口描述針對(duì)在線表單，自定義開發(fā)提交流程接口。6.2.2 訪問地址http://域名/process/extActProcess/startMutilProcess6.2.3 訪問方式POST6.2.4 請(qǐng)求參數(shù)參數(shù)名數(shù)據(jù)類型是否必須示例值默認(rèn)值描述idString345660816d7263e2016d72f288743567表 單業(yè)務(wù)數(shù)據(jù)iddeflowCoString1dev_material_input_00流業(yè)務(wù)關(guān)配置唯編碼程聯(lián)一lformUrStringmaterial/modules/MaterialInputForm流審批時(shí)程附外部表單：支持http開頭的外部表單地址件頁面默認(rèn)展示的PC端表單組件URL地址formUrlMobileStringmaterial/modules/MaterialInputForm外部表單：支持http開頭的外部表單地址流 程審批時(shí)附件頁面默認(rèn)展示的移動(dòng)端表單組件URL地址jsonDataString{name:”jeck”}Json串，額外擴(kuò)展的流程變量值6.2.5 響應(yīng)參數(shù)參數(shù)名父節(jié)點(diǎn)數(shù)據(jù)類型描述successBoolean“true”表示成功，“false”表示失敗codeString返回編碼。0：成功；200：成功；500：服務(wù)器異常；510：訪問權(quán)限認(rèn)證未通過messageString返回處理消息，如“流程發(fā)起成功！”timestampLong時(shí)間戳resultObject響應(yīng)數(shù)據(jù)，流程實(shí)例ID響應(yīng)示例:{"success":true,"message":"流程發(fā)起成功！","code":0,"result":"767509","timestamp":1652426536451}6.3 流程列表6.3.1 接口描述根據(jù)登錄用戶獲取我發(fā)起的流程列表。6.3.2 訪問地址http://域名/ack/task/myApplyProcessList6.3.3 訪問方式GET6.3.4 請(qǐng)求參數(shù)參數(shù)名數(shù)據(jù)類型是否必須示例值默認(rèn)值描述processDefinitinoIdStringprocess1552899184614:1:310008流 程編號(hào)columnStringcreateTime默 認(rèn)排序字段orderStringdesc排 序規(guī)則pageNoint是1當(dāng) 前頁數(shù)pageSizeint是10每 頁返回條數(shù)finishedStateQueryString是isUnFinished未完成IsFinished已完成流 程狀態(tài)_tlong2452651486時(shí) 間戳6.3.5 響應(yīng)參數(shù)參數(shù)名父節(jié)點(diǎn)數(shù)據(jù)類型描述successBoolean“true”表示成功，“false”表示失敗codeString權(quán)限認(rèn)證未通過messageString返回處理消息，如“操作成功！”。timestampLong時(shí)間戳resultObject響應(yīng)數(shù)據(jù)totalresultLong總條數(shù)：當(dāng)前共有多少流程sizeresultLong每頁返回條數(shù)currentresultLong當(dāng)前頁號(hào)pagesresultLong當(dāng)前分頁總頁數(shù)searchCountresultboolean進(jìn)行count查詢true是/false否【默認(rèn)：true】recordsresultArray程）idrecordsString流程實(shí)例IDprocessInstanceIdrecordsString流程實(shí)例IDprocessDefinitionIdrecordsString流程IDprocessDefinitionNamerecordsString流程名稱，如“請(qǐng)假申請(qǐng)”startUserIdrecordsString流程發(fā)起人ID，如“admin”assigneerecordsString流程負(fù)責(zé)人startTimerecordsDate流程開始時(shí)間endTimerecordsDate流程結(jié)束時(shí)間deleteReasonrecordsString流程處理結(jié)果spendTimesrecordsString流程耗時(shí)bpmBizTitlerecordsString業(yè)務(wù)標(biāo)題，如“請(qǐng)假單”6.4 流程作廢6.4.1 接口描述流程作廢后單據(jù)狀態(tài)為作廢狀態(tài)，不能在重新發(fā)起流程。6.4.2 訪問地址http://域名/act/task/invalidProcess6.4.3 訪問方式PUT6.4.4 請(qǐng)求參數(shù)參數(shù)名數(shù)據(jù)類型是否必須示例值默認(rèn)值描述processInstanceIdString是347577流 程示例id6.4.5 響應(yīng)參數(shù)參數(shù)名父節(jié)點(diǎn)數(shù)據(jù)類型描述successBoolean示失敗codeString返回編碼。0：成功；200：成功；500：服務(wù)器異常；510：訪問權(quán)限認(rèn)證未通過messageLong時(shí)間戳resultObject響應(yīng)數(shù)據(jù)6.5 流程取回6.5.1 接口描述我發(fā)起的流程取回操作，流程取回后單據(jù)狀態(tài)為待提交狀態(tài)，可重新發(fā)起流程。6.5.2 訪問地址http://域名/act/task/callBackProcess6.5.3 訪問方式PUT6.5.4 請(qǐng)求參數(shù)參數(shù)名數(shù)據(jù)類型是否必須示例值默認(rèn)值描述processInstanceIdString是347577流 程示例id6.5.5 響應(yīng)參數(shù)參數(shù)名父節(jié)點(diǎn)數(shù)據(jù)類型描述successBoolean示失敗codeString返回編碼。0：成功；200：成功；500：服務(wù)器異常；510：訪問權(quán)限認(rèn)證未通過messageString返回處理消息timestampLong時(shí)間戳resultObject響應(yīng)數(shù)據(jù)6.6 流程任務(wù)跟蹤6.6.1 接口描述根據(jù)流程實(shí)例ID獲取流程任務(wù)跟蹤歷史列表。6.6.2 訪問地址http://域名/act/task/processHistoryList6.6.3 訪問方式GET6.6.4 請(qǐng)求參數(shù)PAGEPAGE9參數(shù)名數(shù)據(jù)類型是否必須示例值默認(rèn)值描述processInstanceIdString是流程實(shí)例ID_tlong1560928599時(shí)間戳6.6.5 響應(yīng)參數(shù)參數(shù)名父節(jié)點(diǎn)數(shù)據(jù)類型描述successBoolean“true”表示成功，“false”表示失敗codeString權(quán)限認(rèn)證未通過messageString返回處理消息，如“操作成功！”。timestampLong時(shí)間戳resultObject響應(yīng)數(shù)據(jù)totalresultLong總條數(shù)：當(dāng)前流程任務(wù)數(shù)sizeresultLong每頁返回條數(shù)currentresultLong當(dāng)前頁號(hào)pagesresultLong當(dāng)前分頁總頁數(shù)searchCountresultboolean進(jìn)行count查詢true是/false否【默認(rèn)：true】recordsresultArray程）idrecordsString任務(wù)idnamerecordsString任務(wù)名稱assigneerecordsString任務(wù)辦理人startTimerecordsDate任務(wù)開始時(shí)間endTimerecordsDate任務(wù)結(jié)束時(shí)間taskDueTimerecordsLong任務(wù)耗時(shí)processDefinitionIdrecordsString流程ID（任務(wù)都屬于某個(gè)流程）processDefinitionNamerecordsString流程名稱processInstacnceIdrecordsString流程實(shí)例IDbpmBizTitlerecordsString業(yè)務(wù)標(biāo)題deleteReasonrecordsString任務(wù)處理結(jié)果6.7 我的任務(wù)列表PAGEPAGE106.7.1 接口描述根據(jù)登錄用戶獲取待我審批任務(wù)列表（我的任務(wù)列表）。6.7.2 訪問地址http://域名/act/task/list6.7.3 訪問方式GET6.7.4 請(qǐng)求參數(shù)參數(shù)名數(shù)據(jù)類型是否必須示例值默認(rèn)值描述processDefinitinoIdStringprocess1552899184614:1:310008流 程編號(hào)userNameStringadmin任 務(wù)發(fā)起人columnStringcreateTime默 認(rèn)排序字段orderStringdesc排 序規(guī)則pageNoint是1當(dāng) 前頁數(shù)pageSizeint是10每 頁返回條數(shù)_tlong2452651486時(shí) 間戳6.7.5 響應(yīng)參數(shù)參數(shù)名父節(jié)點(diǎn)數(shù)據(jù)類型描述successBoolean“true”表示成功，“false”表示失敗codeString返回編碼。0：成功；200：成功；500：服務(wù)器異常；510：訪問權(quán)限認(rèn)證未通過messageString返回處理消息，如“操作成功！”。timestampLong時(shí)間戳resultObject響應(yīng)數(shù)據(jù)totalresultLong總條數(shù)：當(dāng)前共有多少任務(wù)sizeresultLong每頁返回條數(shù)currentresultLong當(dāng)前頁號(hào)pagesresultLong當(dāng)前分頁總頁數(shù)searchCountresultboolean進(jìn)行count查詢true是/false否【默認(rèn)：true】recordsresultArray任務(wù)數(shù)組（任務(wù)都屬于某個(gè)流程）idrecordsString任務(wù)idtaskIdrecordsString任務(wù)定義keytaskNamerecordsString任務(wù)名稱taskAssigneeIdrecordsString任務(wù)辦理人IDtaskAssigneeNamerecordsString任務(wù)辦理人名稱taskBeginTimerecordsDate任務(wù)開始時(shí)間taskEndTimerecordsDate任務(wù)結(jié)束時(shí)間taskDueTimerecordsLong任務(wù)耗時(shí)taskUrgerecordsBoolean任務(wù)是否催辦taskUrgeRemarkrecordsBoolean任務(wù)催辦備注信息processDefinitionIdrecordsString流程ID（任務(wù)都屬于某個(gè)流程）processDefinitionNamerecordsString流程名稱processInstacnceIdrecordsString流程實(shí)例IDprocessApplyUserIdrec