一體化辦公協(xié)同系統(tǒng)電子公文服務(wù)接口規(guī)范

附件4一體化辦公協(xié)同系統(tǒng)電子公文服務(wù)接口規(guī)范

概述本規(guī)范主要約定一體化辦公協(xié)同系統(tǒng)電子公文處理系統(tǒng)接口規(guī)范，主要包括：公文應(yīng)用接口、公文在線編輯服務(wù)接口（WPS整合接口）、電子簽章整合接口。適用范圍本規(guī)范用于及下屬各單位在一體化辦公協(xié)同系統(tǒng)中實(shí)施的電子公文處理系統(tǒng)。參考標(biāo)準(zhǔn)《黨政機(jī)關(guān)電子公文應(yīng)用接口規(guī)范》（GB/T33478-2016）電子公文系統(tǒng)服務(wù)接口規(guī)范流程應(yīng)用接口總覽本章節(jié)主要約定集團(tuán)統(tǒng)一電子公文系統(tǒng)的流程服務(wù)接口，原則上未來(lái)所有外部系統(tǒng)均應(yīng)該按照此規(guī)范進(jìn)行對(duì)接。應(yīng)用接口清單如下：序號(hào)接口名稱接口描述備注1創(chuàng)建新公文流程接口doCreateWorkflowRequest2公文流程提交接口submitWorkflowRequest3公文流程退回接口nextNodeByReject4公文流程轉(zhuǎn)發(fā)接口forwardWorkflowRequest5獲取待辦數(shù)量接口getToDoWorkflowRequestCount6獲取待辦列表接口getToDoWorkflowRequestList7取得已辦工作流類型數(shù)量接口getHendledWorkflowRequestCount8取得已辦流程列表接口getHendledWorkflowRequestList應(yīng)用接口詳述創(chuàng)建新公文流程接口接口名稱：創(chuàng)建新公文流程接口接口地址：http://IP地址:端口/services/WorkflowService?wsdl接口方法：doCreateWorkflowRequest功能說明：根據(jù)請(qǐng)求信息對(duì)象創(chuàng)建一條新的公文流程，請(qǐng)求信息對(duì)象中需包含創(chuàng)建人、創(chuàng)建流程id和表單的數(shù)據(jù)參數(shù)說明： 輸入：參數(shù)名稱參數(shù)參數(shù)類型說明請(qǐng)求信息對(duì)象in0WorkflowRequestInfo對(duì)象見以下示例用戶idin1Int返回值：參數(shù)名稱參數(shù)參數(shù)類型說明流程requestidrequestidString小于0表示失敗-1：創(chuàng)建流程失敗-2：用戶沒有流程創(chuàng)建權(quán)限-3：創(chuàng)建流程基本信息失敗-4：保存表單主表信息失敗-5：更新緊急程度失敗-6：流程操作者失敗-7：流轉(zhuǎn)至下一節(jié)點(diǎn)失敗-8：節(jié)點(diǎn)附加操作失敗接口對(duì)象示例：1）WorkflowRequestInfo工作流請(qǐng)求信息/** *請(qǐng)求ID */ privateStringrequestId; /** *請(qǐng)求標(biāo)題 */ privateStringrequestName; /** *請(qǐng)求重要級(jí)別 */ privateStringrequestLevel; /** *短信提醒 */ privateStringmessageType; /** *流程類型 */ privateWorkflowBaseInfoworkflowBaseInfo; /** *當(dāng)前節(jié)點(diǎn)名稱 */ privateStringcurrentNodeName; /** *當(dāng)前節(jié)點(diǎn)Id */ privateStringcurrentNodeId; /** *流程狀態(tài) */ privateStringstatus; /** *創(chuàng)建者 */ privateStringcreatorId; /** *創(chuàng)建時(shí)間 */ privateStringcreateTime; /** *最后操作者名稱 */ privateStringlastOperatorName; /** *最后操作時(shí)間 */ privateStringlastOperateTime; /** *是否可查看 */ privatebooleancanView; /** *是否可編輯 */ privatebooleancanEdit; /** *簽字意見是否必填 */ privatebooleanmustInputRemark; /** *主表信息 */ privateWorkflowMainTableInfoworkflowMainTableInfo; /** *明細(xì)表信息 */ privateWorkflowDetailTableInfo[]workflowDetailTableInfos; /** *流轉(zhuǎn)日志信息 */ privateWorkflowRequestLog[]workflowRequestLogs; /** *HTML顯示模板 *0iPad *1iPhone */ privateString[]WorkflowHtmlTemplete; /** *解析后的HTML顯示內(nèi)容 *0iPad *1iPhone */ privateString[]WorkflowHtmlShow; /** *被代理人 */ privateStringbeagentid; /** *流程短語(yǔ) */ privateString[][]workflowPhrases;2）WorkflowBaseInfo工作流信息 /** *工作流ID */ privateStringworkflowId; /** *工作流標(biāo)題 */ privateStringworkflowName; /** *工作流類型ID */ privateStringworkflowTypeId; /** *工作流類型名稱 */ privateStringworkflowTypeName;JAVA代碼調(diào)用示例. /** *創(chuàng)建流程，支持多明細(xì)，并且?guī)Ц郊侄?-目前只支持一個(gè)附件，并且是（http格式的） *@throwsException */publicstaticvoidcreateRequest()throwsException{ //主字段WorkflowRequestTableField[]wrti=newWorkflowRequestTableField[4];//字段信息 wrti[0]=newWorkflowRequestTableField(); wrti[0].setFieldName("mutiresource");//被留言人 wrti[0].setFieldValue("111");//被留言人字段的值，111為被留言人id wrti[0].setView(true);//字段是否可見 wrti[0].setEdit(true);//字段是否可編輯 wrti[1]=newWorkflowRequestTableField(); wrti[1].setFieldName("remark");//留言內(nèi)容 wrti[1].setFieldValue("test"); wrti[1].setView(true); wrti[1].setEdit(true); wrti[2]=newWorkflowRequestTableField(); wrti[2].setFieldName("resource_n");//留言人 wrti[2].setFieldValue("111"); wrti[2].setView(true); wrti[2].setEdit(true); wrti[3]=newWorkflowRequestTableField(); wrti[3].setFieldName("fj2");//附件 wrti[3].setFieldType("http:baidu_sylogo1.gif");//http:開頭代表該字段為附件字段 wrti[3].setFieldValue("/img/baidu_sylogo1.gif");//附件地址 wrti[3].setView(true); wrti[3].setEdit(true); WorkflowRequestTableRecord[]wrtri=newWorkflowRequestTableRecord[1];//主字段只有一行數(shù)據(jù) wrtri[0]=newWorkflowRequestTableRecord(); wrtri[0].setWorkflowRequestTableFields(wrti); WorkflowMainTableInfowmi=newWorkflowMainTableInfo(); wmi.setRequestRecords(wrtri); //明細(xì)字段 WorkflowDetailTableInfowdti[]=newWorkflowDetailTableInfo[2];//兩個(gè)明細(xì)表0明細(xì)表1,1明細(xì)表2 //明細(xì)表1start wrtri=newWorkflowRequestTableRecord[2];//數(shù)據(jù)行數(shù)，假設(shè)添加2行明細(xì)數(shù)據(jù) //第一行 wrti=newWorkflowRequestTableField[3];//每行3個(gè)字段 wrti[0]=newWorkflowRequestTableField(); wrti[0].setFieldName("sl");//數(shù)量 wrti[0].setFieldValue("11"); wrti[0].setView(true); wrti[0].setEdit(true); wrti[1]=newWorkflowRequestTableField(); wrti[1].setFieldName("dj");//單價(jià) wrti[1].setFieldValue("2"); wrti[1].setView(true); wrti[1].setEdit(true)； wrti[2]=newWorkflowRequestTableField(); wrti[2].setFieldName("xj");//小記 wrti[2].setFieldValue("22"); wrti[2].setView(true); wrti[2].setEdit(true); wrtri[0]=newWorkflowRequestTableRecord(); wrtri[0].setWorkflowRequestTableFields(wrti); //第二行 wrti=newWorkflowRequestTableField[3];//每行3個(gè)字段 wrti[0]=newWorkflowRequestTableField(); wrti[0].setFieldName("sl");//數(shù)量 wrti[0].setFieldValue("110"); wrti[0].setView(true); wrti[0].setEdit(true); wrti[1]=newWorkflowRequestTableField(); wrti[1].setFieldName("dj");//單價(jià) wrti[1].setFieldValue("2"); wrti[1].setView(true); wrti[1].setEdit(true); wrti[2]=newWorkflowRequestTableField(); wrti[2].setFieldName("xj");//小記 wrti[2].setFieldValue("220"); wrti[2].setView(true); wrti[2].setEdit(true); wrtri[1]=newWorkflowRequestTableRecord(); wrtri[1].setWorkflowRequestTableFields(wrti); wdti[0]=newWorkflowDetailTableInfo(); wdti[0].setWorkflowRequestTableRecords(wrtri);//加入明細(xì)表1的數(shù)據(jù) //明細(xì)表1end //明細(xì)表2start wrtri=newWorkflowRequestTableRecord[1];//數(shù)據(jù)行數(shù)，假設(shè)添加1行明細(xì)數(shù)據(jù) //第一行 wrti=newWorkflowRequestTableField[3];//每行3個(gè)字段 wrti[0]=newWorkflowRequestTableField(); wrti[0].setFieldName("cl3");// wrti[0].setFieldValue("11"); wrti[0].setView(true); wrti[0].setEdit(true); wrti[1]=newWorkflowRequestTableField(); wrti[1].setFieldName("cl1111");// wrti[1].setFieldValue("2"); wrti[1].setView(true); wrti[1].setEdit(true)； wrtri[0]=newWorkflowRequestTableRecord(); wrtri[0].setWorkflowRequestTableFields(wrti); wdti[1]=newWorkflowDetailTableInfo(); wdti[1].setWorkflowRequestTableRecords(wrtri);//加入明細(xì)表2的數(shù)據(jù) //明細(xì)表2end WorkflowBaseInfowbi=newWorkflowBaseInfo(); wbi.setWorkflowId("5");//workflowid5代表內(nèi)部留言 WorkflowRequestInfowri=newWorkflowRequestInfo();//流程基本信息 wri.setCreatorId("111");//創(chuàng)建人id wri.setRequestLevel("2");//0正常，1重要，2緊急 wri.setRequestName("留言測(cè)試接口");//流程標(biāo)題 wri.setWorkflowMainTableInfo(wmi);//添加主字段數(shù)據(jù) wri.setWorkflowBaseInfo(wbi); wri.setWorkflowDetailTableInfos(wdti);//執(zhí)行創(chuàng)建流程接口 WorkflowServicePortTypeProxyWorkflowServicePortTypeProxy=newWorkflowServicePortTypeProxy(); Stringrequestid=WorkflowServicePortTypeProxy.doCreateWorkflowRequest(wri,111); System.out.println("requestid:"+requestid); }公文流程提交接口接口名稱：公文流程提交接口接口地址：http://IP地址:端口/services/WorkflowService?wsdl接口方法：submitWorkflowRequest功能說明：公文流程提交接口參數(shù)說明： 輸入：參數(shù)名稱參數(shù)參數(shù)類型說明請(qǐng)求信息對(duì)象in0WorkflowRequestInfo請(qǐng)求idin1Intrequestid提交人IDIn2Intuserid類型In3Stringtype提交意見In4Stringremark返回值：參數(shù)名稱參數(shù)參數(shù)類型說明BooleanTrue成功False失敗公文流程退回接口接口名稱：公文流程退回接口接口地址：http://IP地址:端口/services/WorkflowService?wsdl接口方法：nextNodeByReject功能說明：公文流程退回接口參數(shù)說明： 輸入：參數(shù)名稱參數(shù)參數(shù)類型說明請(qǐng)求idin0Intrequestid提交人IDin1Intuserid退回意見In2Stringremark返回值：參數(shù)名稱參數(shù)參數(shù)類型說明BooleanTrue成功False失敗公文流程轉(zhuǎn)發(fā)接口接口名稱：公文流程轉(zhuǎn)發(fā)接口接口地址：http://IP地址:端口/services/WorkflowService?wsdl接口方法：forwardWorkflowRequest功能說明：公文流程轉(zhuǎn)發(fā)接口參數(shù)說明： 輸入：參數(shù)名稱參數(shù)參數(shù)類型說明請(qǐng)求idin0Intrequestid接收人idin1StringForwardoperator接收人id多個(gè)用逗號(hào)分隔轉(zhuǎn)發(fā)意見In2Stringremark用戶用戶idIn3IntuserId客戶端ip地址In4Stringclientip返回值：參數(shù)名稱參數(shù)參數(shù)類型說明BooleanTrue成功False失敗獲取待辦數(shù)量接口接口名稱：獲取待辦數(shù)量接口接口地址：http://IP地址:端口/services/WorkflowService?wsdl接口方法：getToDoWorkflowRequestCount功能說明：返回滿足條件的用戶可以得到的待辦數(shù)目參數(shù)說明：參數(shù)名稱參數(shù)參數(shù)類型說明用戶idin0IntuserId接收人idin1StringString[]conditions查詢流程的條件,為字符串?dāng)?shù)組返回值：參數(shù)名稱參數(shù)參數(shù)類型說明Int代辦的數(shù)量獲取待辦列表接口接口名稱：獲取待辦列表接口接口地址：http://IP地址:端口/services/WorkflowService?wsdl接口方法：getToDoWorkflowRequestList功能說明：根據(jù)參數(shù)條件獲取需處理任務(wù)列表排除創(chuàng)建節(jié)點(diǎn)任務(wù)參數(shù)說明：參數(shù)名稱參數(shù)參數(shù)類型說明當(dāng)前頁(yè)數(shù)in0intpageNo每頁(yè)的分頁(yè)數(shù)量in1intpageSize總行數(shù)In2intrecordCount用戶idIn3intuserId查詢條件In4String[]查詢流程的條件,為字符串?dāng)?shù)組類型conditions返回值：參數(shù)名稱參數(shù)參數(shù)類型說明List請(qǐng)求基本信息列表取得已辦工作流類型數(shù)量接口接口名稱：取得已辦工作流類型數(shù)量接口接口地址：http://IP地址:端口/services/WorkflowService?wsdl接口方法：getHendledWorkflowRequestCount功能說明：取得已辦工作流類型數(shù)量接口參數(shù)說明：參數(shù)名稱參數(shù)參數(shù)類型說明用戶idIn0intuserid查詢條件In1String[]查詢條件字符串?dāng)?shù)組conditions返回值：參數(shù)名稱參數(shù)參數(shù)類型說明Int可創(chuàng)建流程數(shù)量取得已辦流程列表接口接口名稱：取得已辦流程列表接口接口地址：http://IP地址:端口/services/WorkflowService?wsdl接口方法：getHendledWorkflowRequestList功能說明：根據(jù)參數(shù)條件獲得已辦流程列表參數(shù)說明：參數(shù)名稱參數(shù)參數(shù)類型說明當(dāng)前頁(yè)數(shù)In0intpageNo每頁(yè)的分頁(yè)數(shù)量In1intpageSize總行數(shù)In2intrecordCount用戶idIn3intuserId查詢條件In4String[]查詢流程的條件,為字符串?dāng)?shù)組類型conditions返回值：參數(shù)名稱參數(shù)參數(shù)類型說明List請(qǐng)求基本信息列表公文在線編輯服務(wù)接口本章節(jié)主要約定電子公文系統(tǒng)的流式文件的應(yīng)用接口。應(yīng)用接口清單如下：序號(hào)接口名稱接口描述備注1查詢結(jié)果接口用于查詢文檔操作的結(jié)果。所有的異步操作會(huì)返回2文檔轉(zhuǎn)換的接口用于文檔轉(zhuǎn)PDF、轉(zhuǎn)TXT、轉(zhuǎn)PNG3合并文檔接口用于文檔合并注：合并文檔不支持批量操作4加水印接口文檔添加水印功能水印支持文件格式：doc、docx、pdf支持文字水印、圖片水印5刪除批注接口刪除文檔中所有批注信息6操作修訂接口接收文檔所有修訂內(nèi)容7填充模板接口根據(jù)傳入書簽數(shù)據(jù)，填充模板文件中書簽位置8多步操作提供多步操作，適用場(chǎng)景--如果想對(duì)文檔先清稿，再加水印，然后轉(zhuǎn)換為PDF輸出等。如果多步中帶merge操作，輸出結(jié)果為1個(gè)文檔，不帶則按fileInfos中輸入文件輸出對(duì)應(yīng)操作后的文檔應(yīng)用接口詳述查詢結(jié)果接口接口名稱：查詢結(jié)果的接口接口地址：http://{ip}/api/v2/cps/getResults?taskID={taskID}&appid={{appid}}&signature={{signature}}接口方法：GET功能說明：用于查詢文檔操作的結(jié)果參數(shù)說明：輸入：參數(shù)名稱參數(shù)參數(shù)類型說明taskIDStringtaskID，用于對(duì)接系統(tǒng)做數(shù)據(jù)管理，后期查詢用appidStringsignatureString返回值：參數(shù)名稱參數(shù)參數(shù)類型說明taskIDStringtaskID，用于對(duì)接系統(tǒng)做數(shù)據(jù)管理，后期查詢用任務(wù)類型taskTypeString任務(wù)類型，convert、merge、wartermark、deleteComments、opRevisions、multiOperate等任務(wù)狀態(tài)codeint0：已完成，1：未完成，等待單文件操作結(jié)果dataarray單文件操作結(jié)果接口調(diào)用示例：http://{ip}/api/v2/cps/getResults?taskID={taskID}&appid={{appid}}&signature={{signature}}接口返回值示例：說明示例操作完成{"taskID":"1234","taskType":"convert","code":0,"data":[{"fileID":"5cc1769f-52fd-fc07-2182-654f-1234564e","downloadUrl":"/1.doc","errCode":200,"status":"StatusCompleted","desc":"轉(zhuǎn)換成功"},{"fileID":"5cc1769f-52fd-fc07-2182-654f-6563564e","downloadUrl":"","errCode":40010000,"status":"StatusErrored","desc":"格式不支持"},]}操作未完成{"taskID":"1234","taskType":"convert","code":1,"data":[]}文檔轉(zhuǎn)換的接口接口名稱：文檔轉(zhuǎn)換的接口接口地址：http://{ip}/api/v2/cps/convert?appid={{appid}}&signature={{signature}}接口方法：POST功能說明：文檔轉(zhuǎn)換的接口（轉(zhuǎn)PDF、轉(zhuǎn)TXT、轉(zhuǎn)PNG）參數(shù)說明： 輸入：參數(shù)名稱參數(shù)參數(shù)類型是否必填說明文件數(shù)組fileInfosarray是文件數(shù)組轉(zhuǎn)換類型convertTypeint是轉(zhuǎn)換類型，1-PDF，2-TXT，3-PNG圖片轉(zhuǎn)換時(shí)的參數(shù)convertArgsConvertArgs否圖片轉(zhuǎn)換時(shí)的參數(shù)"convertArgs":{"isLongImg":2}轉(zhuǎn)換優(yōu)先級(jí)priorityint是轉(zhuǎn)換優(yōu)先級(jí)，1-6，一共6個(gè)等級(jí)，1優(yōu)先級(jí)最高，6最低回調(diào)地址cbstring否回調(diào)地址ConvertArgs參數(shù)信息：參數(shù)參數(shù)類型是否必填說明示例isLongImgint否1-長(zhǎng)圖，2-轉(zhuǎn)散圖，提供壓縮包形式下載，默認(rèn)為1"convertArgs":{"isLongImg":2} 返回值：參數(shù)名稱參數(shù)參數(shù)類型說明狀態(tài)碼codeint狀態(tài)碼獲取結(jié)果的urldataString獲取結(jié)果的url結(jié)果說明messageString結(jié)果說明 接口調(diào)用示例：請(qǐng)求頭調(diào)用示例Header:Content-Type:application/json{"fileInfos":[{"location":"/1.doc","fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"doc","sourceType":2"args":{}},{"location":"/1.doc","fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"doc","sourceType":2"args":{}}],"convertType":3,"convertArgs":{"isLongImg":2},"priority":1,"cb":"/cb"}Header:Content-Type:multipart/form-data"params":{"fileInfos":[{"fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"doc","sourceType":3},{"fileID":"5cc1769f-52fd-fc07-2182-654f-453f5f0f","ext":"doc","sourceType":3}],"convertType":3,"convertArgs":{"isLongImg":2},"priority":1,"cb":"/cb"}接口返回值示例：說明示例操作完成{"code":200,"data":"http://localhost:8260/api/v2/cps/getResults?taskID=officed-n1-3c7a8215-6c10-46e1-8930-ac00b778e5f4",//獲取"message":"Taskentryqueue!"}合并文檔接口接口名稱：合并文檔接口接口地址：http://{ip}/api/v2/cps/merge?appid={{appid}}&signature={{signature}}接口方法：POST功能說明：合并文檔（word、PDF）（合并文檔不支持批量操作）參數(shù)說明： 輸入：參數(shù)名稱參數(shù)參數(shù)類型是否必填說明文件數(shù)組fileInfosarray是文件數(shù)組openHeadFootint是1-合并文件，2-合并文件并且添加頁(yè)眉頁(yè)腳outFileNamestring否合并后的結(jié)果文件名,無(wú)需自帶后綴，僅在openHeadFoot=2時(shí)有效headFootArgsMergePDFHeaderAndFoot否合并時(shí)頁(yè)眉頁(yè)腳的參數(shù)，openHeadFoot=2時(shí)有效轉(zhuǎn)換優(yōu)先級(jí)priorityint是轉(zhuǎn)換優(yōu)先級(jí)，1-6，一共6個(gè)等級(jí)，1優(yōu)先級(jí)最高，6最低回調(diào)地址cbstring否回調(diào)地址MergePDFHeaderAndFoot參數(shù)信息：1）headFootArgs在openHeadFoot=2時(shí)有效，openHeadFoot=1時(shí)無(wú)效2）headFootArgs默認(rèn)參數(shù)：3）備注：12號(hào)字體為小四字體參數(shù)參數(shù)類型是否必填說明示例fontNamestring否字體類型：支持【"宋體","黑體","楷體","微軟雅黑","幼圓","華文行楷","華文琥珀"】"headFootArgs":{"fontName":"宋體","fontSize":12}fontSizefloat32否字體大小 返回值：參數(shù)名稱參數(shù)參數(shù)類型說明狀態(tài)碼codeint狀態(tài)碼獲取結(jié)果的urldataString獲取結(jié)果的url結(jié)果說明messageString結(jié)果說明 接口調(diào)用示例：1）用戶可以在fileinfo里面添加name字段，自定義頁(yè)眉信息，然后根據(jù)頁(yè)眉信息去生成書簽2）用戶如果在fileinfo的name字段不填寫值，頁(yè)眉信息將為空，書簽會(huì)顯示“空標(biāo)題”請(qǐng)求頭調(diào)用示例Header:Content-Type:application/json{"fileInfos":[{"location":"/1.pdf","fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"pdf","name":"test1","sourceType":2,"args":{}},{"location":"/1.pdf","fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"pdf","name":"test2","sourceType":2,"args":{}}],"openHeadFoot":2,"priority":1,"outFileName":"test3","headFootArgs":{"fontName":"宋體","fontSize":13.3},"cb":"/cb"}Header:Content-Type:multipart/form-data"params":{"fileInfos":[{"fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"pdf","name":"test1","sourceType":3},{"fileID":"163f5f0f-52fd-fc07-2182-654f-5cc1769f","ext":"pdf","name":"test2","sourceType":3}],"openHeadFoot":2,"priority":1,"outFileName":"test3","headFootArgs":{"fontName":"宋體","fontSize":13.3},"cb":"/cb"}接口返回值示例：說明示例操作完成{"code":200,"data":"http://localhost:8260/api/v2/cps/getResults?taskID=officed-n1-3c7a8215-6c10-46e1-8930-ac00b778e5f4",//獲取"message":"Taskentryqueue!"}加水印接口接口名稱：合并文檔接口接口地址：http://{ip}/api/v2/cps/watermark?appid={{appid}}&signature={{signature}}接口方法：POST功能說明：加水印（圖片水印、文字水印） 1）水印支持文件格式：doc、docx、pdf 2）支持文字水印、圖片水印參數(shù)說明： 輸入：參數(shù)名稱參數(shù)參數(shù)類型是否必填說明文件數(shù)組fileInfosarray是文件數(shù)組水印類別watermarkTypeint否水印類別：1：字符串水印2：圖片水印3：圖文混排水印水印內(nèi)容watermarkstringwatermarkType=1或者3時(shí)必填水印的文本內(nèi)容水印的通用設(shè)置watermarkSettingwatermarkSetting否水印的通用設(shè)置，具體參數(shù)信息見下文圖片水印參數(shù)imageWaterimageWaterwatermarkType=2時(shí)必填圖片水印的參數(shù)，具體參數(shù)信息見下文角標(biāo)參數(shù)cornerImageLogocornerImageLogo否角標(biāo)的參數(shù)，角標(biāo)和watermarkType取值無(wú)關(guān)，可傳多個(gè)轉(zhuǎn)換優(yōu)先級(jí)priorityint是轉(zhuǎn)換優(yōu)先級(jí)，1-6，一共6個(gè)等級(jí)，1優(yōu)先級(jí)最高，6最低回調(diào)地址cbstring否回調(diào)地址watermarkSettin參數(shù)信息：1）watermarkSetting可不傳，如果不傳會(huì)以默認(rèn)配置加水印2）watermarkSetting默認(rèn)參數(shù)參數(shù)參數(shù)類型是否必填說明示例heightstring否多行水印之前的垂直間距"watermarkSetting":{"height":200,"fillstyle":"rgba(192,192,192,0.6)","font":"normal40px微軟雅黑","rotate":-0.78539,"opacity":0.6,"waterMarkHeight":170,"waterMarkWidth":195,"inerSpace":20,"innerWrapLine":false,}fillstylestring否水印的透明度，默認(rèn)值：rgba(192,192,192,0.6)fontstring否水印的字體，默認(rèn)值："normal40px微軟雅黑"rotatefloat32否水印的旋轉(zhuǎn)弧度，默認(rèn)-0.78539角度*π/180opacityfloat32否圖片水印透明度，默認(rèn)0.3waterMarkHeightint否圖文模式下，單個(gè)水印的高度,默認(rèn)值：170waterMarkWidthint否圖文模式下，單個(gè)水印的寬度，默認(rèn)值：195inerSpaceint否合成圖片時(shí)，圖片和文字之間的水平距離，默認(rèn)值20innerWrapLineboolean否是否折行(圖文水印模式)，默認(rèn)falseimageWate參數(shù)信息：1）imageWater如果沒有圖片水印可不傳2）單圖片水印不支持灰度處理，文字圖片合成新圖片支持參數(shù)參數(shù)類型是否必填說明示例imageUrlstring是創(chuàng)建session時(shí)上傳圖片的id"imageWater":{"imageUrl":"/imageUrl.png","sourceType":2,"waterMode":1}sourceTypeint是文件來(lái)源1-本地文件（localfile）2-http文件下載地址（Content-Type：application/json）3-formData中的圖片ID（Content-Type:multipart/form-data）grayScalebool否是否灰度處理cornerImageLogo參數(shù)信息：1）角標(biāo)的參數(shù)，角標(biāo)和watermarkType取值無(wú)關(guān)2）可傳多個(gè)，定位不同位置參數(shù)參數(shù)類型是否必填說明示例urlstring是創(chuàng)建session時(shí)上傳圖片的id"cornerImageLogo":[{"url":"/cornerImageLogo.png","sourceType":2,"waterPos":3}]sourceTypeint是文件來(lái)源1-本地文件（localfile）2-http文件下載地址（Content-Type：application/json）3-formData中的圖片ID（Content-Type:multipart/form-data）waterPosint是水印位置0.center1.topleft2.topcenter3.topright4.bottomleft5.bottomcenter6.bottomrightgrayScalebool否目前暫不支持灰度處理 返回值：參數(shù)名稱參數(shù)參數(shù)類型說明狀態(tài)碼codeint狀態(tài)碼獲取結(jié)果的urldataString獲取結(jié)果的url結(jié)果說明messageString結(jié)果說明 接口調(diào)用示例：請(qǐng)求頭調(diào)用示例Header:Content-Type:application/json{"fileInfos":[{"location":"/1.pdf","fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"pdf","sourceType":2"args":{}},{"location":"/2.pdf","fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"pdf","sourceType":2"args":{}}],"watermarkType":3,"watermark":"test2019年6月5日20:26:56金山文檔","watermarkSetting":{"height":200,"opacity":0.3,"rotate":-0.78539},"imageWater":{"imageUrl":"/imageUrl.png","sourceType":2,"waterMode":1},"cornerImageLogo":[{"url":"/cornerImageLogo.png","sourceType":2,"waterPos":3}]"priority":1,"cb":"/cb"}Header:Content-Type:multipart/form-data"params":{"fileInfos":[{"fileID":"5cc1769f-52fd-fc07-2182-654f-1234564e","sourceType":3,"ext":"pdf"},{"fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","sourceType":3,"ext":"pdf"}],"watermarkType":3,"watermark":"test2019年6月5日20:26:56金山文檔","watermarkSetting":{"height":200,"opacity":0.3,"rotate":-0.78539},"imageWater":{"imageUrl":"5cc1769f-52fd-fc07-2182-654f-625f5f0f","sourceType":3,"waterMode":1},"cornerImageLogo":[{"url":"5cc1769f-52fd-fc07-2182-654f-1654810e","sourceType":3,"waterPos":3}]"priority":1,"cb":"/cb"}接口返回值示例：說明示例操作完成{"code":200,"data":"http://localhost:8260/api/v2/cps/getResults?taskID=officed-n1-3c7a8215-6c10-46e1-8930-ac00b778e5f4",//獲取"message":"Taskentryqueue!"}刪除批注接口接口名稱：刪除批注接口接口地址：http://{ip}/api/v2/cps/deleteComments?appid={{appid}}&signature={{signature}}接口方法：POST功能說明：刪除批注參數(shù)說明： 輸入：參數(shù)名稱參數(shù)參數(shù)類型是否必填說明文件數(shù)組fileInfosarray是文件數(shù)組轉(zhuǎn)換優(yōu)先級(jí)priorityint是轉(zhuǎn)換優(yōu)先級(jí)，1-6，一共6個(gè)等級(jí)，1優(yōu)先級(jí)最高，6最低回調(diào)地址cbstring否回調(diào)地址 返回值：參數(shù)名稱參數(shù)參數(shù)類型說明狀態(tài)碼codeint狀態(tài)碼獲取結(jié)果的urldataString獲取結(jié)果的url結(jié)果說明messageString結(jié)果說明 接口調(diào)用示例：請(qǐng)求頭調(diào)用示例Header:Content-Type:application/json{"fileInfos":[{"location":"/1.doc","fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"doc","sourceType":2"args":{}},{"location":"/2.doc","fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"doc","sourceType":2"args":{}}],"priority":1,"cb":"/cb"}Header:Content-Type:multipart/form-data"params":{"fileInfos":[{"fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"doc","sourceType":3},{"fileID":"5cc1769f-52fd-fc07-2182-654f-253f5f0f","ext":"doc","sourceType":3}],"priority":1,"cb":"/cb"}接口返回值示例：說明示例操作完成{"code":200,"data":"http://localhost:8260/api/v2/cps/getResults?taskID=officed-n1-3c7a8215-6c10-46e1-8930-ac00b778e5f4",//獲取"message":"Taskentryqueue!"}操作修訂接口接口名稱：操作修訂接口接口地址：http://{ip}/api/v2/cps/opRevisions?appid={{appid}}&signature={{signature}}接口方法：POST功能說明：操作修訂接口（接收文檔所有修訂內(nèi)容）參數(shù)說明： 輸入：參數(shù)名稱參數(shù)參數(shù)類型是否必填說明文件數(shù)組fileInfosarray是文件數(shù)組轉(zhuǎn)換優(yōu)先級(jí)priorityint是轉(zhuǎn)換優(yōu)先級(jí)，1-6，一共6個(gè)等級(jí)，1優(yōu)先級(jí)最高，6最低回調(diào)地址cbstring否回調(diào)地址 返回值：參數(shù)名稱參數(shù)參數(shù)類型說明狀態(tài)碼codeint狀態(tài)碼獲取結(jié)果的urldataString獲取結(jié)果的url結(jié)果說明messageString結(jié)果說明 接口調(diào)用示例：調(diào)用示例請(qǐng)求頭{"fileInfos":[{"location":"/1.doc","fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"doc","sourceType":2"args":{}},{"location":"/2.doc","fileID":"5cc1769f-52fd-fc07-2182-654f-253f5f0f","ext":"doc","sourceType":2"args":{}}],"priority":1,"cb":"/cb"}Header:Content-Type:multipart/form-data"params":{"fileInfos":[{"fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"doc","sourceType":3},{"fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"doc","sourceType":3}],"priority":1,"cb":"/cb"}接口返回值示例：說明示例操作完成{"code":200,"data":"http://localhost:8260/api/v2/cps/getResults?taskID=officed-n1-3c7a8215-6c10-46e1-8930-ac00b778e5f4",//獲取"message":"Taskentryqueue!"}填充模板接口接口名稱：填充模板接口接口地址：http://{ip}/api/v2/cps/fillTemplate?appid={{appid}}&signature={{signature}}接口方法：POST功能說明：填充模板接口（根據(jù)傳入書簽數(shù)據(jù)，填充模板文件中書簽位置）參數(shù)說明： 輸入：參數(shù)名稱參數(shù)參數(shù)類型是否必填說明文件數(shù)組fileInfosarray是文件數(shù)組填充數(shù)據(jù)fillDataarray是填充數(shù)據(jù)轉(zhuǎn)換優(yōu)先級(jí)priorityint是轉(zhuǎn)換優(yōu)先級(jí)，1-6，一共6個(gè)等級(jí)，1優(yōu)先級(jí)最高，6最低回調(diào)地址cbstring否回調(diào)地址fillData參數(shù)信息：參數(shù)參數(shù)類型是否必填說明示例bookmarkstring是書簽名稱"headFootArgs":{"fontName":"宋體","fontSize":12}contentstring是填充內(nèi)容typestring否填充類型，0-文字，1-文檔extstring是type=1時(shí)有效，為文件的后綴 返回值：參數(shù)名稱參數(shù)參數(shù)類型說明狀態(tài)碼codeint狀態(tài)碼獲取結(jié)果的urldataString獲取結(jié)果的url結(jié)果說明messageString結(jié)果說明 接口調(diào)用示例：請(qǐng)求頭調(diào)用示例Header:Content-Type:application/json{"fileInfos":[{"location":"file:///D:/測(cè)試模板.docx","fileID":"5-dfsdfsddd1sdffdasdsasdsdaf1","ext":"docx","sourceType":1,"args":{}},{"location":"file:///D:/測(cè)試模板2.docx","fileID":"6-df11111af1","ext":"docx","sourceType":1,"args":{}}],"fillData":[{"bookmark":"Telephone","content":"123456789","type":0},{"bookmark":"ContentTitle","content":"測(cè)試數(shù)據(jù)","type":0},{"bookmark":"Company","content":"測(cè)試公司","type":0},{"bookmark":"Contacts","content":"李四","type":0},{"bookmark":"Content","content":"file:///D:/測(cè)試文檔.docx","ext":"docx","type":1}],"priority":1,"cb":"http://localhost:8261/api/v1/cb"}Header:Content-Type:multipart/form-data"params":{{"fileInfos":[{"fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"docx","sourceType":3,},{"fileID":"5cc1769f-52fd-fc07-2182-654f-253f5f0f","ext":"docx","sourceType":3,}],"fillData":[{"bookmark":"Telephone","content":"123456789","type":0},{"bookmark":"ContentTitle","content":"測(cè)試數(shù)據(jù)","type":0},{"bookmark":"Company","content":"測(cè)試公司","type":0},{"bookmark":"Contacts","content":"李四","type":0},{"bookmark":"Content","content":"file:///D:/測(cè)試文檔.docx","ext":"docx","type":1}],"priority":1,"cb":"http://localhost:8261/api/v1/cb"}}接口返回值示例：說明示例操作完成{"code":200,"data":"http://localhost:8260/api/v2/cps/getResults?taskID=officed-n1-3c7a8215-6c10-46e1-8930-ac00b778e5f4",//獲取"message":"Taskentryqueue!"}多步操作接口名稱：多步操作接口接口地址：http://{ip}/api/v2/cps/multiOperate?appid={{appid}}&signature={{signature}}接口方法：POST功能說明：填充模板接口（根據(jù)傳入書簽數(shù)據(jù)，填充模板文件中書簽位置）參數(shù)說明： 輸入：參數(shù)名稱參數(shù)參數(shù)類型是否必填說明文件數(shù)組fileInfosarray是文件數(shù)組操作步驟的數(shù)組opStepsarray是操作步驟的數(shù)組轉(zhuǎn)換優(yōu)先級(jí)priorityint是轉(zhuǎn)換優(yōu)先級(jí)，1-6，一共6個(gè)等級(jí)，1優(yōu)先級(jí)最高，6最低回調(diào)地址cbstring否回調(diào)地址 返回值：參數(shù)名稱參數(shù)參數(shù)類型說明狀態(tài)碼codeint狀態(tài)碼獲取結(jié)果的urldataString獲取結(jié)果的url結(jié)果說明messageString結(jié)果說明 接口調(diào)用示例：請(qǐng)求頭調(diào)用示例Header:Content-Type:application/json{"fileInfos":[{"location":"/1.doc","fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"doc","sourceType":2"args":{}}],"opSteps":[{"operate":"opRevisions","args":{"accept":1}},{"operate":"watermark","args":{"watermarkType":3,"watermark":"test2019年6月5日20:26:56金山文檔","watermarkSetting":{"height":200,"opacity":0.3,"rotate":-0.78539},"imageWater":{"imageUrl":"/imageUrl.png","sourceType":2,"waterMode":1},"cornerImageLogo":[{"url":"/cornerImageLogo.png","sourceType":2,"waterPos":3}]}},{"operate":"convert","args":{"convertType":1}}],"priority":1,"cb":"/cb"}Header:Content-Type:multipart/form-data"params":{"fileInfos":[{"fileID":"5cc1769f-52fd-fc07-2182-654f-163f5f0f","ext":"doc","sourceType":3}],"opSteps":[{"operate":"opRevisions","args":{"accept":1}},{"operate":"watermark","args":{"watermarkType":3,"watermark":"test2019年6月5日20:26:56金山文檔","watermarkSetting":{"height":200,"opacity":0.3,"rotate":-0.78539},"imageWater":{"imageUrl":"5cc1769f-52fd-fc07-2182-654f-625f5f0f","sourceType":3,"waterMode":1},"cornerImageLogo":[{"url":"5cc1769f-52fd-fc07-2182-654f-1654810e","sourceType":3,"waterPos":3}]}},{"operate":"convert","args":{"convertType":1}}],"priority":1,"cb":"/cb"}接口返回值示例：說明示例操作完成{"code":200,"data":"http://localhost:8260/api/v2/cps/getResults?taskID=officed-n1-3c7a8215-6c10-46e1-8930-ac00b778e5f4",//獲取"message":"Taskentryqueue!"}電子簽章整合接口本章節(jié)主要約定電子公文系統(tǒng)的電子簽章應(yīng)用接口，應(yīng)用接口清單如下：序號(hào)接口名稱接口描述備注1公司公章簽署運(yùn)營(yíng)方可以調(diào)用該接口直接簽署公司公章，無(wú)需展現(xiàn)簽署頁(yè)面（只能簽署內(nèi)部企業(yè)的公章）2個(gè)人簽署運(yùn)營(yíng)方可以調(diào)用該接口直接簽署個(gè)人簽名，無(wú)需展現(xiàn)簽署頁(yè)面（只能簽署內(nèi)部員工）。注：個(gè)人簽署時(shí)必須有個(gè)人簽名：（1）用戶提前在簽章平臺(tái)中維護(hù)好簽名；（2）通過接口中的sealStr指定簽名；（3）指定接口中的generatePersonSeal為true，此時(shí)簽章平臺(tái)檢測(cè)到用戶無(wú)簽名時(shí)會(huì)自動(dòng)生成一個(gè)簽名。3公文簽署頁(yè)面對(duì)于簽署中的公文，可以調(diào)用此接口來(lái)獲取簽署頁(yè)面鏈接，用戶可以打開簽署鏈接簽署公文。注：如果傳入的簽署方不存在，則動(dòng)態(tài)添加簽署方；支持動(dòng)態(tài)添加簽署方的簽署動(dòng)作。此鏈接的有效期默認(rèn)為30分鐘。應(yīng)用接口詳述公司公章簽署接口名稱：公司公章簽署接口接口地址：/contract/signbycompany接口方法：POST功能說明：運(yùn)營(yíng)方可以調(diào)用該接口直接簽署公司公章，無(wú)需展現(xiàn)簽署頁(yè)面（只能簽署內(nèi)部公司的公章）參數(shù)說明： 輸入：參數(shù)參數(shù)類型是否必填說明contractIdString必須填寫其中一個(gè)公文IDbizIdString公文的唯一標(biāo)識(shí)（第三方系統(tǒng)業(yè)務(wù)ID)tenantNameString是公司名稱stampersArray[Stamper]否簽署位置，為空時(shí)簽署不可見簽名，參考【Stamper】noSignAllKeywordBoolean否不簽署所有關(guān)鍵字位置，默認(rèn)為true，即只簽署第1個(gè)關(guān)鍵字useDefaultSealBoolean否是否使用默認(rèn)印章簽署，默認(rèn)true（僅在已設(shè)置簽署位置未設(shè)置印章的情況下生效）Stamper參數(shù)信息：參數(shù)參數(shù)類型是否必填說明documentIdstring是文檔IDtypeStamperType是簽章類型：SEALCORPORATE（公章）,ACROSSPAGE（騎縫章）,TIMESTAMP（時(shí)間戳）sealIdstring否印章ID，指定簽署文件所用印章xfloat坐標(biāo)指定位置時(shí)必傳，關(guān)鍵字定位時(shí)選傳指定簽署位置橫坐標(biāo)（以文檔左下角為原點(diǎn)）yfloatpageint坐標(biāo)指定位置時(shí)必傳指定簽署位置的頁(yè)碼，從1開始allPageboolean否是否簽署所有頁(yè)面，為true時(shí)指定所有頁(yè)碼keywordstring否定位文檔關(guān)鍵字 返回值：參數(shù)名稱參數(shù)參數(shù)類型說明響應(yīng)碼codeint狀態(tài)碼0：請(qǐng)求成功1000000：未知錯(cuò)誤1000001：參數(shù)錯(cuò)誤響應(yīng)消息messageString響應(yīng)消息 接口調(diào)用示例：請(qǐng)求頭調(diào)用示例Header:Content-Type:application/jsonPOST/contract/signbycompanyHTTP/1.1

Host:hostname

Content-Type:application/json

x-qys-accesstoken:DNq3uuJesv

x-qys-timestamp:0

x-qys-signature:4501cf3255ba2e87cef3458827bc7677

{

"contractId":"2456446599913828356",

"tenantName":"測(cè)試公司",

"stampers":[

{

"documentId":"2456446523330031618",

"type":"SEAL_CORPORATE",

"sealId":"2472032341465210888",

"page":1,

"x":0.1,

"y":0.1

}

]

}接口返回值示例：說明示例操作完成{

"code":0,

"message":"SUCCESS"

}個(gè)人簽署接口名稱：個(gè)人簽署接口接口地址：/contract/signbyperson接口方法：POST功能說明：運(yùn)營(yíng)方可以調(diào)用該接口直接簽署個(gè)人簽名，無(wú)需展現(xiàn)簽署頁(yè)面（只能簽署內(nèi)部員工）參數(shù)說明： 輸入：參數(shù)參數(shù)類型是否必填說明contractIdString必須填寫其中一個(gè)公文IDbizIdString公文的唯一標(biāo)識(shí)（第三方系統(tǒng)業(yè)務(wù)ID)tenantNameString是公司名稱contactString聯(lián)系方式、員工編號(hào)必須填一個(gè)簽署人聯(lián)系方式，聯(lián)系方式允許使用大陸、臺(tái)灣和香港的手機(jī)號(hào)，臺(tái)灣和香港的手機(jī)號(hào)格式為：區(qū)號(hào)+空格+手機(jī)號(hào)，例：8529xxxxxxxreceiverNumberString簽署方的員工編號(hào)cardNoString否簽署人身份證號(hào)碼generatePersonSealBoolean否是否自動(dòng)根據(jù)用戶名生成個(gè)人簽名，已存在則不生成，默認(rèn)不自動(dòng)生成stampersArray[Stamper]是簽署信息，詳情參考StamperStamper參數(shù)信息：參數(shù)參數(shù)類型是否必填說明documentIdstring是公文文檔IDtypeStamperType是簽章類型：SEAL_PERSONAL（個(gè)人簽名）,TIMESTAMP（時(shí)間戳）sealStrint否簽名圖片的base格式字符串；為空時(shí)取用戶已有簽名圖片xfloat坐標(biāo)指定位置時(shí)必傳，關(guān)鍵字定位時(shí)選傳指定簽署位置橫坐標(biāo)（以文檔左下角為原點(diǎn)）yfloatpageint坐標(biāo)指定位置時(shí)必傳指定簽署位置的頁(yè)碼，從1開始allPageboolean否是否簽署所有頁(yè)面，為true時(shí)指定所有頁(yè)碼keywordstring否定位文檔關(guān)鍵字 返回值：參數(shù)名稱參數(shù)參數(shù)類型說明響應(yīng)碼codeint狀態(tài)碼0：請(qǐng)求成功1000000：未知錯(cuò)誤1000001：參數(shù)錯(cuò)誤響應(yīng)消息messageString響應(yīng)消息 接口調(diào)用示例：請(qǐng)求頭調(diào)用示例Header:Content-Type:application/jsonPOST/contract/signbypersonHTTP/1.1

Host:hostname

x-qys-accesstoken:DNq3uuJesv

x-qys-timestamp:0

x-qys-signature:4501cf3255ba2e87cef3458827bc7677

Content-Type:application/json

{

"contractId":"2456446599913828356",

"tenantName":"張三",

"contact":,

"stampers":[

{

"documentId":"2456446523330031618",

"type":"SEAL_PERSONAL",

"page":1,

"x":0.1,

"y":0.1

}

]

}接口返回值示例：說明示例操作完成{

"code":0,

"message":"SUCCESS"

}公文簽署頁(yè)面接口名稱：公文簽署頁(yè)面接口接口地址：/contract/signurl接口方法：POST功能說明：對(duì)于簽署中的公文，可以調(diào)用此接口來(lái)獲取簽署頁(yè)面鏈接，用戶可以打開簽署鏈接簽署公文。參數(shù)說明： 輸入：參數(shù)參數(shù)類型是否必填說明contractIdString必須填寫其中一個(gè)公文IDbizIdString公文的唯一標(biāo)識(shí)（第三方系統(tǒng)業(yè)務(wù)ID)tenantIdLongtenantId和tenantName必填一個(gè)簽署方ID（公司ID/個(gè)人ID）tenantNameString簽署方名稱tenantTypeString是簽署方類型：COMPANY（外