一体化办公协同系统电子公文服务接口规范

附件4一体化办公协同系统电子公文服务接口规范

概述本规范主要约定一体化办公协同系统电子公文处理系统接口规范，主要包括：公文应用接口、公文在线编辑服务接口（WPS整合接口）、电子签章整合接口。适用范围本规范用于及下属各单位在一体化办公协同系统中实施的电子公文处理系统。参考标准《党政机关电子公文应用接口规范》（GB/T33478-2016）电子公文系统服务接口规范流程应用接口总览本章节主要约定集团统一电子公文系统的流程服务接口，原则上未来所有外部系统均应该按照此规范进行对接。应用接口清单如下：序号接口名称接口描述备注1创建新公文流程接口doCreateWorkflowRequest2公文流程提交接口submitWorkflowRequest3公文流程退回接口nextNodeByReject4公文流程转发接口forwardWorkflowRequest5获取待办数量接口getToDoWorkflowRequestCount6获取待办列表接口getToDoWorkflowRequestList7取得已办工作流类型数量接口getHendledWorkflowRequestCount8取得已办流程列表接口getHendledWorkflowRequestList应用接口详述创建新公文流程接口接口名称：创建新公文流程接口接口地址：http://IP地址:端口/services/WorkflowService?wsdl接口方法：doCreateWorkflowRequest功能说明：根据请求信息对象创建一条新的公文流程，请求信息对象中需包含创建人、创建流程id和表单的数据参数说明： 输入：参数名称参数参数类型说明请求信息对象in0WorkflowRequestInfo对象见以下示例用户idin1Int返回值：参数名称参数参数类型说明流程requestidrequestidString小于0表示失败-1：创建流程失败-2：用户没有流程创建权限-3：创建流程基本信息失败-4：保存表单主表信息失败-5：更新紧急程度失败-6：流程操作者失败-7：流转至下一节点失败-8：节点附加操作失败接口对象示例：1）WorkflowRequestInfo工作流请求信息/** *请求ID */ privateStringrequestId; /** *请求标题 */ privateStringrequestName; /** *请求重要级别 */ privateStringrequestLevel; /** *短信提醒 */ privateStringmessageType; /** *流程类型 */ privateWorkflowBaseInfoworkflowBaseInfo; /** *当前节点名称 */ privateStringcurrentNodeName; /** *当前节点Id */ privateStringcurrentNodeId; /** *流程状态 */ privateStringstatus; /** *创建者 */ privateStringcreatorId; /** *创建时间 */ privateStringcreateTime; /** *最后操作者名称 */ privateStringlastOperatorName; /** *最后操作时间 */ privateStringlastOperateTime; /** *是否可查看 */ privatebooleancanView; /** *是否可编辑 */ privatebooleancanEdit; /** *签字意见是否必填 */ privatebooleanmustInputRemark; /** *主表信息 */ privateWorkflowMainTableInfoworkflowMainTableInfo; /** *明细表信息 */ privateWorkflowDetailTableInfo[]workflowDetailTableInfos; /** *流转日志信息 */ privateWorkflowRequestLog[]workflowRequestLogs; /** *HTML显示模板 *0iPad *1iPhone */ privateString[]WorkflowHtmlTemplete; /** *解析后的HTML显示内容 *0iPad *1iPhone */ privateString[]WorkflowHtmlShow; /** *被代理人 */ privateStringbeagentid; /** *流程短语 */ privateString[][]workflowPhrases;2）WorkflowBaseInfo工作流信息 /** *工作流ID */ privateStringworkflowId; /** *工作流标题 */ privateStringworkflowName; /** *工作流类型ID */ privateStringworkflowTypeId; /** *工作流类型名称 */ privateStringworkflowTypeName;JAVA代码调用示例. /** *创建流程，支持多明细，并且带附件字段--目前只支持一个附件，并且是（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");//留言内容 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];//主字段只有一行数据 wrtri[0]=newWorkflowRequestTableRecord(); wrtri[0].setWorkflowRequestTableFields(wrti); WorkflowMainTableInfowmi=newWorkflowMainTableInfo(); wmi.setRequestRecords(wrtri); //明细字段 WorkflowDetailTableInfowdti[]=newWorkflowDetailTableInfo[2];//两个明细表0明细表1,1明细表2 //明细表1start wrtri=newWorkflowRequestTableRecord[2];//数据行数，假设添加2行明细数据 //第一行 wrti=newWorkflowRequestTableField[3];//每行3个字段 wrti[0]=newWorkflowRequestTableField(); wrti[0].setFieldName("sl");//数量 wrti[0].setFieldValue("11"); wrti[0].setView(true); wrti[0].setEdit(true); wrti[1]=newWorkflowRequestTableField(); wrti[1].setFieldName("dj");//单价 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个字段 wrti[0]=newWorkflowRequestTableField(); wrti[0].setFieldName("sl");//数量 wrti[0].setFieldValue("110"); wrti[0].setView(true); wrti[0].setEdit(true); wrti[1]=newWorkflowRequestTableField(); wrti[1].setFieldName("dj");//单价 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);//加入明细表1的数据 //明细表1end //明细表2start wrtri=newWorkflowRequestTableRecord[1];//数据行数，假设添加1行明细数据 //第一行 wrti=newWorkflowRequestTableField[3];//每行3个字段 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);//加入明细表2的数据 //明细表2end WorkflowBaseInfowbi=newWorkflowBaseInfo(); wbi.setWorkflowId("5");//workflowid5代表内部留言 WorkflowRequestInfowri=newWorkflowRequestInfo();//流程基本信息 wri.setCreatorId("111");//创建人id wri.setRequestLevel("2");//0正常，1重要，2紧急 wri.setRequestName("留言测试接口");//流程标题 wri.setWorkflowMainTableInfo(wmi);//添加主字段数据 wri.setWorkflowBaseInfo(wbi); wri.setWorkflowDetailTableInfos(wdti);//执行创建流程接口 WorkflowServicePortTypeProxyWorkflowServicePortTypeProxy=newWorkflowServicePortTypeProxy(); Stringrequestid=WorkflowServicePortTypeProxy.doCreateWorkflowRequest(wri,111); System.out.println("requestid:"+requestid); }公文流程提交接口接口名称：公文流程提交接口接口地址：http://IP地址:端口/services/WorkflowService?wsdl接口方法：submitWorkflowRequest功能说明：公文流程提交接口参数说明： 输入：参数名称参数参数类型说明请求信息对象in0WorkflowRequestInfo请求idin1Intrequestid提交人IDIn2Intuserid类型In3Stringtype提交意见In4Stringremark返回值：参数名称参数参数类型说明BooleanTrue成功False失败公文流程退回接口接口名称：公文流程退回接口接口地址：http://IP地址:端口/services/WorkflowService?wsdl接口方法：nextNodeByReject功能说明：公文流程退回接口参数说明： 输入：参数名称参数参数类型说明请求idin0Intrequestid提交人IDin1Intuserid退回意见In2Stringremark返回值：参数名称参数参数类型说明BooleanTrue成功False失败公文流程转发接口接口名称：公文流程转发接口接口地址：http://IP地址:端口/services/WorkflowService?wsdl接口方法：forwardWorkflowRequest功能说明：公文流程转发接口参数说明： 输入：参数名称参数参数类型说明请求idin0Intrequestid接收人idin1StringForwardoperator接收人id多个用逗号分隔转发意见In2Stringremark用户用户idIn3IntuserId客户端ip地址In4Stringclientip返回值：参数名称参数参数类型说明BooleanTrue成功False失败获取待办数量接口接口名称：获取待办数量接口接口地址：http://IP地址:端口/services/WorkflowService?wsdl接口方法：getToDoWorkflowRequestCount功能说明：返回满足条件的用户可以得到的待办数目参数说明：参数名称参数参数类型说明用户idin0IntuserId接收人idin1StringString[]conditions查询流程的条件,为字符串数组返回值：参数名称参数参数类型说明Int代办的数量获取待办列表接口接口名称：获取待办列表接口接口地址：http://IP地址:端口/services/WorkflowService?wsdl接口方法：getToDoWorkflowRequestList功能说明：根据参数条件获取需处理任务列表排除创建节点任务参数说明：参数名称参数参数类型说明当前页数in0intpageNo每页的分页数量in1intpageSize总行数In2intrecordCount用户idIn3intuserId查询条件In4String[]查询流程的条件,为字符串数组类型conditions返回值：参数名称参数参数类型说明List请求基本信息列表取得已办工作流类型数量接口接口名称：取得已办工作流类型数量接口接口地址：http://IP地址:端口/services/WorkflowService?wsdl接口方法：getHendledWorkflowRequestCount功能说明：取得已办工作流类型数量接口参数说明：参数名称参数参数类型说明用户idIn0intuserid查询条件In1String[]查询条件字符串数组conditions返回值：参数名称参数参数类型说明Int可创建流程数量取得已办流程列表接口接口名称：取得已办流程列表接口接口地址：http://IP地址:端口/services/WorkflowService?wsdl接口方法：getHendledWorkflowRequestList功能说明：根据参数条件获得已办流程列表参数说明：参数名称参数参数类型说明当前页数In0intpageNo每页的分页数量In1intpageSize总行数In2intrecordCount用户idIn3intuserId查询条件In4String[]查询流程的条件,为字符串数组类型conditions返回值：参数名称参数参数类型说明List请求基本信息列表公文在线编辑服务接口本章节主要约定电子公文系统的流式文件的应用接口。应用接口清单如下：序号接口名称接口描述备注1查询结果接口用于查询文档操作的结果。所有的异步操作会返回2文档转换的接口用于文档转PDF、转TXT、转PNG3合并文档接口用于文档合并注：合并文档不支持批量操作4加水印接口文档添加水印功能水印支持文件格式：doc、docx、pdf支持文字水印、图片水印5删除批注接口删除文档中所有批注信息6操作修订接口接收文档所有修订内容7填充模板接口根据传入书签数据，填充模板文件中书签位置8多步操作提供多步操作，适用场景--如果想对文档先清稿，再加水印，然后转换为PDF输出等。如果多步中带merge操作，输出结果为1个文档，不带则按fileInfos中输入文件输出对应操作后的文档应用接口详述查询结果接口接口名称：查询结果的接口接口地址：http://{ip}/api/v2/cps/getResults?taskID={taskID}&appid={{appid}}&signature={{signature}}接口方法：GET功能说明：用于查询文档操作的结果参数说明：输入：参数名称参数参数类型说明taskIDStringtaskID，用于对接系统做数据管理，后期查询用appidStringsignatureString返回值：参数名称参数参数类型说明taskIDStringtaskID，用于对接系统做数据管理，后期查询用任务类型taskTypeString任务类型，convert、merge、wartermark、deleteComments、opRevisions、multiOperate等任务状态codeint0：已完成，1：未完成，等待单文件操作结果dataarray单文件操作结果接口调用示例：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":"转换成功"},{"fileID":"5cc1769f-52fd-fc07-2182-654f-6563564e","downloadUrl":"","errCode":40010000,"status":"StatusErrored","desc":"格式不支持"},]}操作未完成{"taskID":"1234","taskType":"convert","code":1,"data":[]}文档转换的接口接口名称：文档转换的接口接口地址：http://{ip}/api/v2/cps/convert?appid={{appid}}&signature={{signature}}接口方法：POST功能说明：文档转换的接口（转PDF、转TXT、转PNG）参数说明： 输入：参数名称参数参数类型是否必填说明文件数组fileInfosarray是文件数组转换类型convertTypeint是转换类型，1-PDF，2-TXT，3-PNG图片转换时的参数convertArgsConvertArgs否图片转换时的参数"convertArgs":{"isLongImg":2}转换优先级priorityint是转换优先级，1-6，一共6个等级，1优先级最高，6最低回调地址cbstring否回调地址ConvertArgs参数信息：参数参数类型是否必填说明示例isLongImgint否1-长图，2-转散图，提供压缩包形式下载，默认为1"convertArgs":{"isLongImg":2} 返回值：参数名称参数参数类型说明状态码codeint状态码获取结果的urldataString获取结果的url结果说明messageString结果说明 接口调用示例：请求头调用示例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）（合并文档不支持批量操作）参数说明： 输入：参数名称参数参数类型是否必填说明文件数组fileInfosarray是文件数组openHeadFootint是1-合并文件，2-合并文件并且添加页眉页脚outFileNamestring否合并后的结果文件名,无需自带后缀，仅在openHeadFoot=2时有效headFootArgsMergePDFHeaderAndFoot否合并时页眉页脚的参数，openHeadFoot=2时有效转换优先级priorityint是转换优先级，1-6，一共6个等级，1优先级最高，6最低回调地址cbstring否回调地址MergePDFHeaderAndFoot参数信息：1）headFootArgs在openHeadFoot=2时有效，openHeadFoot=1时无效2）headFootArgs默认参数：3）备注：12号字体为小四字体参数参数类型是否必填说明示例fontNamestring否字体类型：支持【"宋体","黑体","楷体","微软雅黑","幼圆","华文行楷","华文琥珀"】"headFootArgs":{"fontName":"宋体","fontSize":12}fontSizefloat32否字体大小 返回值：参数名称参数参数类型说明状态码codeint状态码获取结果的urldataString获取结果的url结果说明messageString结果说明 接口调用示例：1）用户可以在fileinfo里面添加name字段，自定义页眉信息，然后根据页眉信息去生成书签2）用户如果在fileinfo的name字段不填写值，页眉信息将为空，书签会显示“空标题”请求头调用示例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）支持文字水印、图片水印参数说明： 输入：参数名称参数参数类型是否必填说明文件数组fileInfosarray是文件数组水印类别watermarkTypeint否水印类别：1：字符串水印2：图片水印3：图文混排水印水印内容watermarkstringwatermarkType=1或者3时必填水印的文本内容水印的通用设置watermarkSettingwatermarkSetting否水印的通用设置，具体参数信息见下文图片水印参数imageWaterimageWaterwatermarkType=2时必填图片水印的参数，具体参数信息见下文角标参数cornerImageLogocornerImageLogo否角标的参数，角标和watermarkType取值无关，可传多个转换优先级priorityint是转换优先级，1-6，一共6个等级，1优先级最高，6最低回调地址cbstring否回调地址watermarkSettin参数信息：1）watermarkSetting可不传，如果不传会以默认配置加水印2）watermarkSetting默认参数参数参数类型是否必填说明示例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否水印的透明度，默认值：rgba(192,192,192,0.6)fontstring否水印的字体，默认值："normal40px微软雅黑"rotatefloat32否水印的旋转弧度，默认-0.78539角度*π/180opacityfloat32否图片水印透明度，默认0.3waterMarkHeightint否图文模式下，单个水印的高度,默认值：170waterMarkWidthint否图文模式下，单个水印的宽度，默认值：195inerSpaceint否合成图片时，图片和文字之间的水平距离，默认值20innerWrapLineboolean否是否折行(图文水印模式)，默认falseimageWate参数信息：1）imageWater如果没有图片水印可不传2）单图片水印不支持灰度处理，文字图片合成新图片支持参数参数类型是否必填说明示例imageUrlstring是创建session时上传图片的id"imageWater":{"imageUrl":"/imageUrl.png","sourceType":2,"waterMode":1}sourceTypeint是文件来源1-本地文件（localfile）2-http文件下载地址（Content-Type：application/json）3-formData中的图片ID（Content-Type:multipart/form-data）grayScalebool否是否灰度处理cornerImageLogo参数信息：1）角标的参数，角标和watermarkType取值无关2）可传多个，定位不同位置参数参数类型是否必填说明示例urlstring是创建session时上传图片的id"cornerImageLogo":[{"url":"/cornerImageLogo.png","sourceType":2,"waterPos":3}]sourceTypeint是文件来源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否目前暂不支持灰度处理 返回值：参数名称参数参数类型说明状态码codeint状态码获取结果的urldataString获取结果的url结果说明messageString结果说明 接口调用示例：请求头调用示例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功能说明：删除批注参数说明： 输入：参数名称参数参数类型是否必填说明文件数组fileInfosarray是文件数组转换优先级priorityint是转换优先级，1-6，一共6个等级，1优先级最高，6最低回调地址cbstring否回调地址 返回值：参数名称参数参数类型说明状态码codeint状态码获取结果的urldataString获取结果的url结果说明messageString结果说明 接口调用示例：请求头调用示例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功能说明：操作修订接口（接收文档所有修订内容）参数说明： 输入：参数名称参数参数类型是否必填说明文件数组fileInfosarray是文件数组转换优先级priorityint是转换优先级，1-6，一共6个等级，1优先级最高，6最低回调地址cbstring否回调地址 返回值：参数名称参数参数类型说明状态码codeint状态码获取结果的urldataString获取结果的url结果说明messageString结果说明 接口调用示例：调用示例请求头{"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功能说明：填充模板接口（根据传入书签数据，填充模板文件中书签位置）参数说明： 输入：参数名称参数参数类型是否必填说明文件数组fileInfosarray是文件数组填充数据fillDataarray是填充数据转换优先级priorityint是转换优先级，1-6，一共6个等级，1优先级最高，6最低回调地址cbstring否回调地址fillData参数信息：参数参数类型是否必填说明示例bookmarkstring是书签名称"headFootArgs":{"fontName":"宋体","fontSize":12}contentstring是填充内容typestring否填充类型，0-文字，1-文档extstring是type=1时有效，为文件的后缀 返回值：参数名称参数参数类型说明状态码codeint状态码获取结果的urldataString获取结果的url结果说明messageString结果说明 接口调用示例：请求头调用示例Header:Content-Type:application/json{"fileInfos":[{"location":"file:///D:/测试模板.docx","fileID":"5-dfsdfsddd1sdffdasdsasdsdaf1","ext":"docx","sourceType":1,"args":{}},{"location":"file:///D:/测试模板2.docx","fileID":"6-df11111af1","ext":"docx","sourceType":1,"args":{}}],"fillData":[{"bookmark":"Telephone","content":"123456789","type":0},{"bookmark":"ContentTitle","content":"测试数据","type":0},{"bookmark":"Company","content":"测试公司","type":0},{"bookmark":"Contacts","content":"李四","type":0},{"bookmark":"Content","content":"file:///D:/测试文档.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":"测试数据","type":0},{"bookmark":"Company","content":"测试公司","type":0},{"bookmark":"Contacts","content":"李四","type":0},{"bookmark":"Content","content":"file:///D:/测试文档.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功能说明：填充模板接口（根据传入书签数据，填充模板文件中书签位置）参数说明： 输入：参数名称参数参数类型是否必填说明文件数组fileInfosarray是文件数组操作步骤的数组opStepsarray是操作步骤的数组转换优先级priorityint是转换优先级，1-6，一共6个等级，1优先级最高，6最低回调地址cbstring否回调地址 返回值：参数名称参数参数类型说明状态码codeint状态码获取结果的urldataString获取结果的url结果说明messageString结果说明 接口调用示例：请求头调用示例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!"}电子签章整合接口本章节主要约定电子公文系统的电子签章应用接口，应用接口清单如下：序号接口名称接口描述备注1公司公章签署运营方可以调用该接口直接签署公司公章，无需展现签署页面（只能签署内部企业的公章）2个人签署运营方可以调用该接口直接签署个人签名，无需展现签署页面（只能签署内部员工）。注：个人签署时必须有个人签名：（1）用户提前在签章平台中维护好签名；（2）通过接口中的sealStr指定签名；（3）指定接口中的generatePersonSeal为true，此时签章平台检测到用户无签名时会自动生成一个签名。3公文签署页面对于签署中的公文，可以调用此接口来获取签署页面链接，用户可以打开签署链接签署公文。注：如果传入的签署方不存在，则动态添加签署方；支持动态添加签署方的签署动作。此链接的有效期默认为30分钟。应用接口详述公司公章签署接口名称：公司公章签署接口接口地址：/contract/signbycompany接口方法：POST功能说明：运营方可以调用该接口直接签署公司公章，无需展现签署页面（只能签署内部公司的公章）参数说明： 输入：参数参数类型是否必填说明contractIdString必须填写其中一个公文IDbizIdString公文的唯一标识（第三方系统业务ID)tenantNameString是公司名称stampersArray[Stamper]否签署位置，为空时签署不可见签名，参考【Stamper】noSignAllKeywordBoolean否不签署所有关键字位置，默认为true，即只签署第1个关键字useDefaultSealBoolean否是否使用默认印章签署，默认true（仅在已设置签署位置未设置印章的情况下生效）Stamper参数信息：参数参数类型是否必填说明documentIdstring是文档IDtypeStamperType是签章类型：SEALCORPORATE（公章）,ACROSSPAGE（骑缝章）,TIMESTAMP（时间戳）sealIdstring否印章ID，指定签署文件所用印章xfloat坐标指定位置时必传，关键字定位时选传指定签署位置横坐标（以文档左下角为原点）yfloatpageint坐标指定位置时必传指定签署位置的页码，从1开始allPageboolean否是否签署所有页面，为true时指定所有页码keywordstring否定位文档关键字 返回值：参数名称参数参数类型说明响应码codeint状态码0：请求成功1000000：未知错误1000001：参数错误响应消息messageString响应消息 接口调用示例：请求头调用示例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":"测试公司",

"stampers":[

{

"documentId":"2456446523330031618",

"type":"SEAL_CORPORATE",

"sealId":"2472032341465210888",

"page":1,

"x":0.1,

"y":0.1

}

]

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

"code":0,

"message":"SUCCESS"

}个人签署接口名称：个人签署接口接口地址：/contract/signbyperson接口方法：POST功能说明：运营方可以调用该接口直接签署个人签名，无需展现签署页面（只能签署内部员工）参数说明： 输入：参数参数类型是否必填说明contractIdString必须填写其中一个公文IDbizIdString公文的唯一标识（第三方系统业务ID)tenantNameString是公司名称contactString联系方式、员工编号必须填一个签署人联系方式，联系方式允许使用大陆、台湾和香港的手机号，台湾和香港的手机号格式为：区号+空格+手机号，例：8529xxxxxxxreceiverNumberString签署方的员工编号cardNoString否签署人身份证号码generatePersonSealBoolean否是否自动根据用户名生成个人签名，已存在则不生成，默认不自动生成stampersArray[Stamper]是签署信息，详情参考StamperStamper参数信息：参数参数类型是否必填说明documentIdstring是公文文档IDtypeStamperType是签章类型：SEAL_PERSONAL（个人签名）,TIMESTAMP（时间戳）sealStrint否签名图片的base格式字符串；为空时取用户已有签名图片xfloat坐标指定位置时必传，关键字定位时选传指定签署位置横坐标（以文档左下角为原点）yfloatpageint坐标指定位置时必传指定签署位置的页码，从1开始allPageboolean否是否签署所有页面，为true时指定所有页码keywordstring否定位文档关键字 返回值：参数名称参数参数类型说明响应码codeint状态码0：请求成功1000000：未知错误1000001：参数错误响应消息messageString响应消息 接口调用示例：请求头调用示例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"

}公文签署页面接口名称：公文签署页面接口接口地址：/contract/signurl接口方法：POST功能说明：对于签署中的公文，可以调用此接口来获取签署页面链接，用户可以打开签署链接签署公文。参数说明： 输入：参数参数类型是否必填说明contractIdString必须填写其中一个公文IDbizIdString公文的唯一标识（第三方系统业务ID)tenantIdLongtenantId和tenantName必填一个签署方ID（公司ID/个人ID）tenantNameString签署方名称tenantTypeString是签署方类型：COMPANY（外