EsignHttpUtil.java 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702
  1. package com.kingdee.eas.custom.esign.util;
  2. import com.alibaba.fastjson.JSON;
  3. import com.alibaba.fastjson.JSONObject;
  4. import com.google.common.collect.Maps;
  5. import com.kingdee.bos.BOSException;
  6. import com.kingdee.bos.Context;
  7. import com.kingdee.bos.ContextUtils;
  8. import com.kingdee.bos.dao.IObjectPK;
  9. import com.kingdee.bos.dao.ormapping.ObjectUuidPK;
  10. import com.kingdee.bos.util.BOSUuid;
  11. import com.kingdee.eas.basedata.person.PersonInfo;
  12. import com.kingdee.eas.common.EASBizException;
  13. import com.kingdee.eas.custom.esign.*;
  14. import com.kingdee.eas.custom.esign.bizEnum.EsignConfigEnum;
  15. import com.kingdee.eas.custom.esign.bizEnum.EsignStatusEnum;
  16. import com.kingdee.eas.custom.esign.bizEnum.SendStatusEnum;
  17. import com.kingdee.eas.custom.esign.tsign.hz.comm.EsignHttpHelper;
  18. import com.kingdee.eas.custom.esign.tsign.hz.comm.EsignHttpResponse;
  19. import com.kingdee.eas.custom.esign.tsign.hz.enums.EsignRequestType;
  20. import com.kingdee.eas.custom.esign.tsign.hz.exception.EsignException;
  21. import com.kingdee.eas.mobileaccess.hr.sHR.config.EASConfig;
  22. import com.kingdee.eas.util.app.DbUtil;
  23. import com.kingdee.jdbc.rowset.IRowSet;
  24. import org.apache.commons.lang3.StringUtils;
  25. import org.apache.http.client.utils.URIBuilder;
  26. import java.net.URI;
  27. import java.net.URISyntaxException;
  28. import java.sql.SQLException;
  29. import java.text.MessageFormat;
  30. import java.util.Locale;
  31. import java.util.Map;
  32. /**
  33. * description: EsignHttpUtil <br>
  34. * date: 17/11/2025 下午 4:26 <br>
  35. * author: lhbj <br>
  36. * version: 1.0 <br>
  37. */
  38. public class EsignHttpUtil {
  39. /**
  40. * 基础请求接口
  41. *
  42. * @param url 请求地址
  43. * @param jsonParm JSON字符串参数
  44. * @param requestType 请求类型 POST/GET
  45. * @param debug 输出日志
  46. * @param sourceId 来源id
  47. * @return
  48. * @throws EsignException
  49. */
  50. public static EsignHttpResponse doCommHttp(Context ctx, String url, String jsonParm, EsignRequestType requestType, Boolean debug, String sourceId, EsignConfigEnum configEnum) throws EsignException {
  51. EsignLogInfo esignLogInfo = new EsignLogInfo();
  52. //
  53. //生成签名鉴权方式的的header
  54. Map<String, String> header = EsignHttpHelper.signAndBuildSignAndJsonHeader(EsignConfig.getInstance().getEsignAppId(),
  55. EsignConfig.getInstance().getEsignAppSecret(), jsonParm, requestType.name(), url, debug);
  56. EsignHttpResponse response = EsignHttpHelper.doCommHttp(EsignConfig.getInstance().getEsignHost(), url, requestType, jsonParm, header, debug);
  57. try {
  58. if (null == ctx) {
  59. ctx = ContextUtils.getContextFromSession();
  60. }
  61. if (null == ctx) {
  62. String currentSolutionName = EASConfig.getInstance().getSlnName();
  63. String currentDatabaseCenter = EASConfig.getInstance().getDcCode();
  64. ctx = new Context(new ObjectUuidPK(), currentSolutionName, currentDatabaseCenter, new Locale("l2"));
  65. }
  66. IEsignLog log = EsignLogFactory.getLocalInstance(ctx);
  67. esignLogInfo.setEsiginName(configEnum);
  68. esignLogInfo.setRequestState(String.valueOf(response.getStatus()));
  69. esignLogInfo.setUrl(url);
  70. esignLogInfo.setRequestData(jsonParm);
  71. esignLogInfo.setResponseData(response.getBody());
  72. esignLogInfo.setSource(sourceId);
  73. IObjectPK pk = log.addnew(esignLogInfo);
  74. response.setLogId(pk.toString());
  75. } catch (Exception e) {
  76. e.printStackTrace();
  77. } finally {
  78. }
  79. //发起接口请求
  80. return response;
  81. }
  82. /**
  83. * POST请求接口
  84. *
  85. * @param url 请求地址
  86. * @param jsonParm JSON字符串参数
  87. * @param debug 输出日志
  88. * @param sourceId 来源id
  89. * @return
  90. * @throws EsignException
  91. */
  92. public static EsignHttpResponse POST(Context ctx, String url, String jsonParm, Boolean debug, String sourceId, EsignConfigEnum configEnum) throws EsignException {
  93. //请求方法
  94. EsignRequestType requestType = EsignRequestType.POST;
  95. return doCommHttp(ctx, url, jsonParm, requestType, debug, sourceId, configEnum);
  96. }
  97. public static EsignHttpResponse POST(Context ctx, String url, String jsonParm, String sourceId, EsignConfigEnum configEnum) throws EsignException {
  98. return POST(ctx, url, jsonParm, false, sourceId, configEnum);
  99. }
  100. /**
  101. * GET请求接口
  102. *
  103. * @param url 请求地址
  104. * @param jsonParm JSON字符串参数
  105. * @param debug 输出日志
  106. * @param sourceId 来源id
  107. * @return
  108. * @throws EsignException
  109. */
  110. public static EsignHttpResponse GET(Context ctx, String url, String jsonParm, Boolean debug, String sourceId, EsignConfigEnum configEnum) throws EsignException {
  111. //请求方法
  112. EsignRequestType requestType = EsignRequestType.GET;
  113. return doCommHttp(ctx, url, jsonParm, requestType, debug, sourceId, configEnum);
  114. }
  115. public static EsignHttpResponse GET(Context ctx, String url, String jsonParm, String sourceId, EsignConfigEnum configEnum) throws EsignException {
  116. return GET(ctx, url, jsonParm, false, sourceId, configEnum);
  117. }
  118. public static EsignHttpResponse DELETE(Context ctx, String url, String jsonParm, String sourceId, EsignConfigEnum configEnum) throws EsignException {
  119. return DELETE(ctx, url, jsonParm, false, sourceId, configEnum);
  120. }
  121. public static EsignHttpResponse DELETE(Context ctx, String url, String jsonParm, Boolean debug, String sourceId, EsignConfigEnum configEnum) throws EsignException {
  122. //请求方法
  123. EsignRequestType requestType = EsignRequestType.DELETE;
  124. return doCommHttp(ctx, url, jsonParm, requestType, debug, sourceId, configEnum);
  125. }
  126. public static EsignHttpResponse getDocTemplatesDetailById(Context ctx, String id) throws EsignException {
  127. return getDocTemplatesDetailById(ctx, id, null);
  128. }
  129. /**
  130. * 查询合同模板中控件详情
  131. * 参考文档:https://open.esign.cn/doc/opendoc/pdf-sign3/aoq509
  132. * 接口地址:https://{host}/v3/doc-templates/{docTemplateId}
  133. * 请求方法:GET
  134. *
  135. * @param id 模板id
  136. * @param sourceId 来源id
  137. * @return
  138. * @throws EsignException
  139. */
  140. public static EsignHttpResponse getDocTemplatesDetailById(Context ctx, String id, String sourceId) throws EsignException {
  141. EsignConfigEnum configEnum = EsignConfigEnum.docTemplatesDetailById;
  142. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  143. apiaddr = MessageFormat.format(apiaddr, id);
  144. String jsonParm = null;
  145. return GET(ctx, apiaddr, jsonParm, sourceId, configEnum);
  146. }
  147. /**
  148. * 填写模板生成文件
  149. * 参考文档:https://open.esign.cn/doc/opendoc/pdf-sign3/mv8a3i
  150. * 接口地址:https://{host}/v3/files/create-by-doc-template
  151. * 请求方法:POST
  152. * 注意事项:componentId与componentKey两个字段不能同时传值,只能一个有值
  153. *
  154. * @param json
  155. * @param sourceId 来源id
  156. * @return
  157. * @throws EsignException
  158. */
  159. public static EsignHttpResponse createByDocTemplate(Context ctx, String json, String sourceId) throws EsignException {
  160. EsignConfigEnum configEnum = EsignConfigEnum.createByDocTemplate;
  161. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  162. return POST(ctx, apiaddr, json, sourceId, configEnum);
  163. }
  164. /**
  165. * 查询机构认证信息
  166. * 参考文档:https://open.esign.cn/doc/opendoc/auth3/xxz4tc
  167. * 接口地址:https://{host}/v3/organizations/identity-info
  168. * 请求方法:GET
  169. * 注意事项:
  170. * 入参中orgId、orgName和orgIDCardNum三个参数只选择一个传入即可查询机构认证信息。
  171. * 查询优先级为 orgId > orgName > orgIDCardNum。
  172. *
  173. * @param orgId
  174. * @param orgName
  175. * @param orgIDCardNum
  176. * @param orgIDCardType 组织机构证件类型(传orgIDCardNum时,该参数为必传)
  177. * CRED_ORG_USCC - 统一社会信用代码 * CRED_ORG_REGCODE - 工商注册号
  178. * @param sourceId 来源id
  179. * @return
  180. * @throws EsignException
  181. */
  182. public static EsignHttpResponse getOrgIdentity_info(Context ctx, String orgId, String orgName, String orgIDCardNum, String orgIDCardType, String sourceId) throws EsignException, URISyntaxException {
  183. EsignConfigEnum configEnum = EsignConfigEnum.organizations_identity_info;
  184. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  185. if (StringUtils.isBlank(orgId) && StringUtils.isBlank(orgName)) {
  186. if (StringUtils.isNotBlank(orgIDCardNum) && StringUtils.isBlank(orgIDCardType)) {
  187. throw new EsignException("传orgIDCardNum时,orgIDCardType参数为必传");
  188. } else {
  189. throw new EsignException("orgId与orgName与orgIDCardNum不能都为空");
  190. }
  191. }
  192. URIBuilder uriBuilder = new URIBuilder(apiaddr);
  193. if (StringUtils.isNotBlank(orgId)) {
  194. uriBuilder.addParameter("orgId", orgId);
  195. }
  196. if (StringUtils.isNotBlank(orgName)) {
  197. uriBuilder.addParameter("orgName", orgName);
  198. }
  199. if (StringUtils.isNotBlank(orgIDCardNum) && StringUtils.isNotBlank(orgIDCardType)) {
  200. uriBuilder.addParameter("orgIDCardNum", orgIDCardNum);
  201. uriBuilder.addParameter("orgIDCardType", orgIDCardType);
  202. }
  203. URI uri = uriBuilder.build(); // 自动编码
  204. apiaddr = uri.toString();
  205. return GET(ctx, apiaddr, null, sourceId, configEnum);
  206. }
  207. public static EsignHttpResponse getOrgIdentity_infoByOrgId(Context ctx, String orgId) throws EsignException, URISyntaxException {
  208. return getOrgIdentity_info(ctx, orgId, null, null, null, null);
  209. }
  210. public static EsignHttpResponse getOrgIdentity_infoByOrgName(Context ctx, String orgName) throws EsignException, URISyntaxException {
  211. return getOrgIdentity_info(ctx, null, orgName, null, null, null);
  212. }
  213. public static EsignHttpResponse getOrgIdentity_infoByOrgIDCardNum(Context ctx, String orgIDCardNum, String orgIDCardType) throws EsignException, URISyntaxException {
  214. return getOrgIdentity_info(ctx, null, null, orgIDCardNum, orgIDCardType, null);
  215. }
  216. /**
  217. * 查询个人认证信息
  218. * 参考文档:https://open.esign.cn/doc/opendoc/auth3/xxz4tc
  219. * 接口地址:https://{host}/v3/persons/identity-info
  220. * 请求方法:GET
  221. * 注意事项:
  222. * 入参中psnId、psnAccount和psnIDCardNum三个参数只选择一个传入即可查询个人的认证信息。
  223. * 查询优先级为 psnId > psnAccount > psnIDCardNum
  224. *
  225. * @param psnId
  226. * @param psnAccount
  227. * @param psnIDCardNum
  228. * @param psnIDCardType 个人证件号类型 (传psnIDCardNum时,证件类型为必传项)
  229. * CRED_PSN_CH_IDCARD - 中国大陆居民身份证
  230. * CRED_PSN_CH_HONGKONG - 香港来往大陆通行证
  231. * CRED_PSN_CH_MACAO - 澳门来往大陆通行证
  232. * CRED_PSN_CH_TWCARD - 台湾来往大陆通行证
  233. * CRED_PSN_PASSPORT - 护照
  234. * @param sourceId 来源id
  235. * @return
  236. * @throws EsignException
  237. */
  238. public static EsignHttpResponse getPersonIdentity_info(Context ctx, String psnId, String psnAccount, String psnIDCardNum, String psnIDCardType, String sourceId) throws EsignException, URISyntaxException {
  239. EsignConfigEnum configEnum = EsignConfigEnum.persons_identity_info;
  240. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  241. if (StringUtils.isBlank(psnId) && StringUtils.isBlank(psnAccount)) {
  242. if (StringUtils.isNotBlank(psnIDCardNum) && StringUtils.isBlank(psnIDCardType)) {
  243. throw new EsignException("传orgIDCardNum时,psnIDCardType参数为必传");
  244. } else {
  245. throw new EsignException("orgId与orgName与orgIDCardNum不能都为空");
  246. }
  247. }
  248. URIBuilder uriBuilder = new URIBuilder(apiaddr);
  249. if (StringUtils.isNotBlank(psnId)) {
  250. uriBuilder.addParameter("psnId", psnId);
  251. }
  252. if (StringUtils.isNotBlank(psnAccount)) {
  253. uriBuilder.addParameter("psnAccount", psnAccount);
  254. }
  255. if (StringUtils.isNotBlank(psnIDCardNum) && StringUtils.isNotBlank(psnIDCardType)) {
  256. uriBuilder.addParameter("psnIDCardNum", psnIDCardNum);
  257. uriBuilder.addParameter("psnIDCardType", psnIDCardType);
  258. }
  259. URI uri = uriBuilder.build(); // 自动编码
  260. apiaddr = uri.toString();
  261. return GET(ctx, apiaddr, null, sourceId, configEnum);
  262. }
  263. public static EsignHttpResponse getPersonIdentity_infoByPsnId(Context ctx, String psnId) throws EsignException, URISyntaxException {
  264. return getPersonIdentity_info(ctx, psnId, null, null, null, null);
  265. }
  266. public static EsignHttpResponse getPersonIdentity_infoByPsnAccount(Context ctx, String psnAccount) throws EsignException, URISyntaxException {
  267. return getPersonIdentity_info(ctx, null, psnAccount, null, null, null);
  268. }
  269. public static EsignHttpResponse getPersonIdentity_infoByOrgIDCardNum(Context ctx, String psnIDCardNum, String psnIDCardType) throws EsignException, URISyntaxException {
  270. return getPersonIdentity_info(ctx, null, null, psnIDCardNum, psnIDCardType, null);
  271. }
  272. /**
  273. * 查询签署流程详情
  274. * 参考文档:https://open.esign.cn/doc/opendoc/pdf-sign3/xxk4q6
  275. * 接口地址:https://{host}/v3/sign-flow/{signFlowId}/detail
  276. * 请求方法:GET
  277. * 注意事项:
  278. *
  279. * @param signFlowId 签署流程ID
  280. * @param sourceId 来源id
  281. * @return
  282. */
  283. public static EsignHttpResponse getSign_fields(Context ctx, String signFlowId, String sourceId) throws EsignException {
  284. EsignConfigEnum configEnum = EsignConfigEnum.detail_sign_fields;
  285. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  286. apiaddr = MessageFormat.format(apiaddr, signFlowId);
  287. return GET(ctx, apiaddr, null, sourceId, configEnum);
  288. }
  289. public static EsignHttpResponse getSign_fields(Context ctx, String signFlowId) throws EsignException {
  290. return getSign_fields(ctx, signFlowId, null);
  291. }
  292. /**
  293. * 追加签署区
  294. * 参考文档:https://open.esign.cn/doc/opendoc/pdf-sign3/ohzup7
  295. * 接口地址:https://{host}/v3/sign-flow/{signFlowId}/signers/sign-fields
  296. * 请求方法:POST
  297. * 注意事项:在追加一个签署区时,请确保流程在开启之前已添加了该签署区所在的待签署文件,参考【追加待签文件】;
  298. * 流程在“草稿”和“签署中”状态时,允许向流程中再追加签署区;
  299. * 【基于文件发起签署】时设置了自动完结(autoFinish为 true)的流程不支持再添加签署区。
  300. *
  301. * @param signFlowId 签署流程ID
  302. * @param json 添加签署方信息
  303. * @param sourceId 来源id
  304. * @return
  305. */
  306. public static EsignHttpResponse addSign_fields(Context ctx, String signFlowId, String json, String sourceId) throws EsignException {
  307. EsignConfigEnum configEnum = EsignConfigEnum.add_sign_fields;
  308. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  309. apiaddr = MessageFormat.format(apiaddr, signFlowId);
  310. return POST(ctx, apiaddr, json, sourceId, configEnum);
  311. }
  312. /**
  313. * 删除签署区
  314. * 参考文档:https://open.esign.cn/doc/opendoc/pdf-sign3/ohzup7
  315. * 接口地址:https://{host}/v3/sign-flow/{signFlowId}/signers/sign-fields
  316. * 请求方法:POST
  317. * 注意事项:在追加一个签署区时,请确保流程在开启之前已添加了该签署区所在的待签署文件,参考【追加待签文件】;
  318. * 流程在“草稿”和“签署中”状态时,允许向流程中再追加签署区;
  319. * 【基于文件发起签署】时设置了自动完结(autoFinish为 true)的流程不支持再添加签署区。
  320. *
  321. * @param signFlowId 签署流程ID
  322. * @param signFieldIds 添加签署方信息
  323. * @param sourceId 来源id
  324. * @return
  325. */
  326. public static EsignHttpResponse delSign_fields(Context ctx, String signFlowId, String signFieldIds, String sourceId) throws EsignException, URISyntaxException {
  327. EsignConfigEnum configEnum = EsignConfigEnum.del_sign_fields;
  328. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  329. apiaddr = MessageFormat.format(apiaddr, signFlowId);
  330. URIBuilder uriBuilder = new URIBuilder(apiaddr);
  331. if (StringUtils.isNotBlank(signFieldIds)) {
  332. uriBuilder.addParameter("signFieldIds", signFieldIds);
  333. }
  334. URI uri = uriBuilder.build(); // 自动编码
  335. apiaddr = uri.toString();
  336. return DELETE(ctx, apiaddr, null, sourceId, configEnum);
  337. }
  338. /**
  339. * 添加抄送方信息
  340. * 参考文档:https://open.esign.cn/doc/opendoc/pdf-sign3/ohzup7
  341. * 接口地址:https://{host}/v3/sign-flow/{signFlowId}/signers/sign-fields
  342. * 请求方法:POST
  343. * 注意事项:
  344. * “抄送方”的概念:
  345. * 指不参与签署文件的机构或个人,可以进行查看签署流程中的签署文件以及附属材料等信息,当流程中的签署方全部完成签署,抄送方也会收到签署完成的通知。
  346. * 接口注意事项:
  347. * 自动完结的流程(autoFinish设置为true)不支持添加抄送方,否则将会报错:“自动归档流程开启后,不允许添加签署区”。
  348. * 添加的抄送方不可与流程中已有的抄送方重复。。
  349. *
  350. * @param signFlowId 签署流程ID
  351. * @param json 添加抄送方信息
  352. * @param sourceId 来源id
  353. * @return
  354. */
  355. public static EsignHttpResponse addCopiers(Context ctx, String signFlowId, String json, String sourceId) throws EsignException {
  356. EsignConfigEnum configEnum = EsignConfigEnum.add_copiers;
  357. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  358. apiaddr = MessageFormat.format(apiaddr, signFlowId);
  359. return POST(ctx, apiaddr, json, sourceId, configEnum);
  360. }
  361. /**
  362. * 删除抄送方信息
  363. * 参考文档:https://open.esign.cn/doc/opendoc/pdf-sign3/bdn9yt
  364. * 接口地址:https://{host}/v3/sign-flow/{signFlowId}/copiers/delete
  365. * <p>
  366. * 请求方法:POST
  367. * 注意事项:流程若已开启,将不支持再删除抄送方信息。
  368. *
  369. * @param signFlowId 签署流程ID
  370. * @param json 删除抄送方信息
  371. * @param sourceId 来源id
  372. * @return
  373. */
  374. public static EsignHttpResponse delCopiers(Context ctx, String signFlowId, String json, String sourceId) throws EsignException {
  375. EsignConfigEnum configEnum = EsignConfigEnum.del_copiers;
  376. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  377. apiaddr = MessageFormat.format(apiaddr, signFlowId);
  378. return POST(ctx, apiaddr, json, sourceId, configEnum);
  379. }
  380. /**
  381. * 基于文件发起签署
  382. * 参考文档:https://open.esign.cn/doc/opendoc/pdf-sign3/su5g42
  383. * 接口地址:https://{host}/v3/sign-flow/create-by-file
  384. * 请求方法:POST
  385. * 注意事项:
  386. * 1. 单个签署流程中对签署文件(docs)要求如下:
  387. * 单个签署流程中所添加的文件个数不可超过50个。
  388. * 单个文件大小不可超过50MB。
  389. * 单个文件内单页大小不可超过20MB(文件内含图片时,需特别关注单页大小)。
  390. * 单个签署流程中所添加的文件大小总和不可超过500MB。
  391. * 2. 单个签署流程中一次性添加的签署方(signers)不要超过10个,如果超过10个后续可以用《追加签署区》接口追加,整个流程不能超过50个签署方。
  392. * 3. 单个签署流程中所添加的签署区(signFields)总和不要超过300个。
  393. * 4. 单个签署流程中对附属材料(attachments)要求如下:
  394. * 单个签署流程中所添加的附件个数不可超过50个。
  395. * 单个附件大小不可超过10MB。
  396. * 5. autoStart自动开启签署流程,默认值 true
  397. * true - 自动开启(发起签署流程,将直接进入“签署中”状态)
  398. * false - 非自动开启(发起“草稿”状态的签署流程,需调用【开启签署流程】接口后流程进入“签署中”状态)
  399. * 补充说明: 自动开启的流程不允许再追加待签署文件,点击这里了解更多流程状态说明。
  400. *
  401. * @param ctx 上下文
  402. * @param personId 签署员工id
  403. * @param fileName 签署文件名称
  404. * @param operatorId 操作人
  405. * @param efileId 发起单据id
  406. * @param json 签署信息
  407. * @return
  408. */
  409. public static EsignHttpResponse create_by_file(Context ctx, String personId, String fileName, String operatorId, String efileId,
  410. String json) throws BOSException {
  411. EsignHttpResponse resp = create_by_file(ctx, personId, fileName, operatorId, efileId, EsignStatusEnum.SIGNING, json);
  412. return resp;
  413. }
  414. public static EsignHttpResponse create_by_file(Context ctx, String personId, String fileName, String operatorId, String efileId,
  415. EsignStatusEnum esignStatus,
  416. String json) throws BOSException {
  417. EsignConfigEnum configEnum = EsignConfigEnum.create_by_file;
  418. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  419. EsignHttpResponse resp = new EsignHttpResponse();
  420. resp.setStatus(500);
  421. /**
  422. * 发起签署前需要新增电子签全域状态总览表
  423. */
  424. IESignGlobalStatusOverview globalStatusOverview = ESignGlobalStatusOverviewFactory.getLocalInstance(ctx);
  425. ESignGlobalStatusOverviewInfo info = new ESignGlobalStatusOverviewInfo();
  426. // try {
  427. // String str = "select fid from CT_ESI_ESGSO where cfefileId=?";
  428. // IRowSet rs = DbUtil.executeQuery(ctx, str, new Object[]{efileId});
  429. // if (rs.next()) {
  430. // String fid = rs.getString("fid");
  431. // info = globalStatusOverview.getESignGlobalStatusOverviewInfo(new ObjectUuidPK(fid));
  432. // }
  433. // } catch (SQLException | EASBizException e) {
  434. // e.printStackTrace();
  435. // }
  436. info.setEsignStatus(esignStatus);
  437. info.setSendStatus(SendStatusEnum.FAILURE);
  438. if (StringUtils.isNotBlank(personId)) {
  439. PersonInfo personInfo = new PersonInfo();
  440. personInfo.setId(BOSUuid.read(personId));
  441. info.setPerson(personInfo);
  442. }
  443. if (StringUtils.isNotBlank(operatorId)) {
  444. PersonInfo operator = new PersonInfo();
  445. operator.setId(BOSUuid.read(operatorId));
  446. info.setOperator(operator);
  447. }
  448. info.setFileName(fileName);
  449. info.setEfileId(efileId);
  450. info.setRequestParams(json);
  451. info.setEsignName(configEnum);
  452. try {
  453. resp = POST(ctx, apiaddr, json, efileId, configEnum);
  454. if (resp.getStatus() >= 200 && resp.getStatus() < 300) {
  455. JSONObject object = JSON.parseObject(resp.getBody());
  456. if ("0".equals(String.valueOf(object.get("code")))) {
  457. JSONObject data = object.getJSONObject("data");
  458. info.setSignFlowId(data.getString("signFlowId"));
  459. info.setSendStatus(SendStatusEnum.SUCCESS);
  460. }
  461. }
  462. info.setSourceBillId(resp.getLogId());
  463. } catch (Exception e) {
  464. e.printStackTrace();
  465. info.setSendStatus(SendStatusEnum.FAILURE);
  466. } finally {
  467. try {
  468. globalStatusOverview.save(info);
  469. } catch (Exception e) {
  470. e.printStackTrace();
  471. }
  472. }
  473. return resp;
  474. }
  475. /**
  476. * 开启签署流程
  477. * 参考文档:https://open.esign.cn/doc/opendoc/pdf-sign3/bdn9yt
  478. * 接口地址:https://{host}/v3/sign-flow/{signFlowId}/start
  479. * <p>
  480. * 请求方法:POST
  481. * 注意事项:流程若已开启,将不支持再删除抄送方信息。
  482. *
  483. * @param signFlowId 签署流程ID
  484. * @param sourceId 来源id
  485. * @return
  486. */
  487. public static EsignHttpResponse start_by_file(Context ctx, String signFlowId, String sourceId) throws EsignException {
  488. EsignConfigEnum configEnum = EsignConfigEnum.start_by_file;
  489. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  490. apiaddr = MessageFormat.format(apiaddr, signFlowId);
  491. return POST(ctx, apiaddr, null, sourceId, configEnum);
  492. }
  493. /**
  494. * 撤销签署流程
  495. * 参考文档:https://open.esign.cn/doc/opendoc/pdf-sign3/klbicu
  496. * 接口地址:https://{host}/v3/sign-flow/{signFlowId}/revoke
  497. * <p>
  498. * 请求方法:POST
  499. * 注意事项:撤销签署中的流程,撤销后签署流程将终止,变为已撤销状态。
  500. *
  501. * @param signFlowId 签署流程ID
  502. * @param revokeReason 撤销原因 撤销原因最多50字
  503. * @param sourceId 来源id
  504. * @return
  505. */
  506. public static EsignHttpResponse revoke_by_file(Context ctx, String signFlowId, String revokeReason, String sourceId) throws EsignException {
  507. EsignConfigEnum configEnum = EsignConfigEnum.revoke_by_file;
  508. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  509. apiaddr = MessageFormat.format(apiaddr, signFlowId);
  510. Map<String, String> jsonMap = Maps.newHashMap();
  511. jsonMap.put("revokeReason", (StringUtils.isNotBlank(revokeReason) ? revokeReason : ""));
  512. String json = JSON.toJSONString(jsonMap);
  513. return POST(ctx, apiaddr, json, sourceId, configEnum);
  514. }
  515. /**
  516. * 催签流程中签署人
  517. * 参考文档:https://open.esign.cn/doc/opendoc/pdf-sign3/yws940
  518. * 接口地址:https://{host}/v3/sign-flow/{signFlowId}/urge
  519. * 请求方法:POST
  520. * 【注意事项】
  521. * 发起签署之后的前半小时不可进行催签;
  522. * 与上一次催签,请至少间隔十分钟再发起下一次催签提醒。
  523. *
  524. * @param signFlowId 签署流程ID
  525. * @param json 催签的签署人信息
  526. * @param sourceId 来源id
  527. * @return
  528. */
  529. public static EsignHttpResponse urge_by_file(Context ctx, String signFlowId, String json, String sourceId) throws EsignException {
  530. EsignConfigEnum configEnum = EsignConfigEnum.urge_by_file;
  531. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  532. apiaddr = MessageFormat.format(apiaddr, signFlowId);
  533. return POST(ctx, apiaddr, json, sourceId, configEnum);
  534. }
  535. /**
  536. * 下载已签署文件及附属材料
  537. * 参考文档:https://open.esign.cn/doc/opendoc/pdf-sign3/kczf8g
  538. * 接口地址:https://{host}/v3/sign-flow/{signFlowId}/file-download-url
  539. * 请求方法:GET
  540. * 【注意事项】
  541. * 未签署完成的流程,无法下载相关文件,否则会报错:"流程非签署完成状态,不允许下载文档"。
  542. *
  543. * @param signFlowId 签署流程ID
  544. * @param urlAvailableDate 下载链接有效期,单位:秒。默认:3600秒(60分钟)
  545. * 可传入:1-3600
  546. * 补充说明:
  547. * 为链接设置有效期是一项安全措施,旨在降低因无关人员访问而导致的信息泄露风险。
  548. * @param sourceId 来源id
  549. * @return
  550. */
  551. public static EsignHttpResponse getFile_download_url(Context ctx, String signFlowId, Integer urlAvailableDate, String sourceId) throws EsignException, URISyntaxException {
  552. EsignConfigEnum configEnum = EsignConfigEnum.file_download_url;
  553. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  554. apiaddr = MessageFormat.format(apiaddr, signFlowId);
  555. if (null != urlAvailableDate && urlAvailableDate > 0 && urlAvailableDate <= 3600) {
  556. URIBuilder uriBuilder = new URIBuilder(apiaddr);
  557. uriBuilder.addParameter("urlAvailableDate", String.valueOf(urlAvailableDate));
  558. URI uri = uriBuilder.build(); // 自动编码
  559. apiaddr = uri.toString();
  560. }
  561. return GET(ctx, apiaddr, null, sourceId, configEnum);
  562. }
  563. /**
  564. * 下载签署中文件
  565. * 参考文档:https://open.esign.cn/doc/opendoc/pdf-sign3/gkgc4729sa67upfn
  566. * 接口地址:https://{host}/v3/sign-flow/{signFlowId}/preview-file-download-url
  567. * 请求方法:GET
  568. * 【注意事项】
  569. * 通过该接口可以下载流程正在签署中的文件进行预览查看,用于开发者内部系统展示合同内容。本接口下载的文件因为是过程中文件所以不支持验签和出证,并且文件中会带有“本文档仅供预览查看”的水印字样。
  570. *
  571. * @param signFlowId 签署流程ID
  572. * @param docFileId 本次签署流程中的文件ID【注】仅支持签署文件,不支持附件
  573. * 可传入:1-3600
  574. * 补充说明:
  575. * 为链接设置有效期是一项安全措施,旨在降低因无关人员访问而导致的信息泄露风险。
  576. * @param sourceId 来源id
  577. * @return
  578. */
  579. public static EsignHttpResponse getPreview_file_download_url(Context ctx, String signFlowId, String docFileId, String sourceId) throws EsignException, URISyntaxException {
  580. EsignConfigEnum configEnum = EsignConfigEnum.preview_file_download_url;
  581. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  582. apiaddr = MessageFormat.format(apiaddr, signFlowId);
  583. URIBuilder uriBuilder = new URIBuilder(apiaddr);
  584. uriBuilder.addParameter("docFileId", docFileId);
  585. URI uri = uriBuilder.build(); // 自动编码
  586. apiaddr = uri.toString();
  587. return GET(ctx, apiaddr, null, sourceId, configEnum);
  588. }
  589. /**
  590. * 查询企业内部印章
  591. * 参考文档:https://open.esign.cn/doc/opendoc/seal3/ups6h1
  592. * 接口地址:https://{host}/v3/seals/org-own-seal-list?orgId=xx&pageNum=1&pageSize=20
  593. * 请求方法:GET
  594. * 【注意事项】
  595. * 查询 orgId (机构企业)名下自身创建的内部自有企业印章,包括印章的编号、名称、状态、印章业务类型、印章图片下载地址等信息。
  596. *
  597. * @param orgId 机构账号ID 【注】用户在e签宝注册实名后才有账号ID,账号ID获取方式请使用【查询机构认证信息】接口通过组织机构名称/组织机构证件号进行查询
  598. * @param pageNum 查询页码
  599. * @param pageSize 每页显示的数量,最大值:20
  600. * @param sealBizTypes 印章业务类型(多项可使用英文逗号分隔)
  601. * PUBLIC - 公章
  602. * CONTRACT - 合同专用章
  603. * FINANCE - 财务专用章
  604. * PERSONNEL - 人事专用章
  605. * LEGAL_PERSON - 法定代表人章
  606. * OMMON - 其他
  607. * @param revocationSeal 是否需要查询已吊销印章,默认不查询 【注】曾经有用印记录的印章删除后即为已吊销状态
  608. * false - 不查询已吊销印章
  609. * ture - 查询已吊销印章
  610. * @param sourceId 来源id
  611. * @return
  612. */
  613. public static EsignHttpResponse getOrg_own_seal_list(Context ctx, String orgId,
  614. Integer pageNum, Integer pageSize,
  615. String sealBizTypes, Boolean revocationSeal,
  616. String sourceId
  617. ) throws EsignException, URISyntaxException {
  618. EsignConfigEnum configEnum = EsignConfigEnum.org_own_seal_list;
  619. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  620. URIBuilder uriBuilder = new URIBuilder(apiaddr);
  621. uriBuilder.addParameter("orgId", orgId);
  622. if(pageNum<0) {
  623. uriBuilder.addParameter("pageNum", String.valueOf(1));
  624. }else {
  625. uriBuilder.addParameter("pageNum", String.valueOf(pageNum));
  626. }
  627. if(pageSize<=0) {
  628. uriBuilder.addParameter("pageSize", String.valueOf(1));
  629. }else if(pageSize>20){
  630. uriBuilder.addParameter("pageSize", String.valueOf(20));
  631. }else {
  632. uriBuilder.addParameter("pageSize", String.valueOf(pageSize));
  633. }
  634. if(StringUtils.isNotBlank(sealBizTypes)){
  635. uriBuilder.addParameter("sealBizTypes", sealBizTypes);
  636. }
  637. if(null!=revocationSeal){
  638. uriBuilder.addParameter("revocationSeal", revocationSeal.toString());
  639. }
  640. URI uri = uriBuilder.build(); // 自动编码
  641. apiaddr = uri.toString();
  642. return GET(ctx, apiaddr, null, sourceId, configEnum);
  643. }
  644. /**
  645. * 查询文件上传状态
  646. * 参考文档:https://open.esign.cn/doc/opendoc/pdf-sign3/qz4aip
  647. * 接口地址:https://{host}/v3/files/{fileId}
  648. * @param ctx
  649. * @param fileId
  650. * @param sourceId
  651. * 请求方法:GET
  652. */
  653. public static EsignHttpResponse getFileStatus(Context ctx,String fileId, String sourceId) throws EsignException {
  654. EsignConfigEnum configEnum = EsignConfigEnum.getFilesState;
  655. String apiaddr = EsignConfig.getInstance().get(configEnum.getValue());
  656. apiaddr = MessageFormat.format(apiaddr, fileId);
  657. //发起接口请求
  658. return GET(ctx, apiaddr, null, sourceId, configEnum);
  659. }
  660. }