接口说明

1.客户端消息类 :ClientMessage

调用相关接口后, 对应人人法响应的数据均封装在此消息类中, 包括响应状态码,响应提示信息。

消息类属性:

private String statusCode;         //返回状态码
private String statusInfo;         //返回状态信息
private String reqJsonBody;        //请求源数据
private String respJsonBody;       //响应源数据
private Sign sign;                 //客户端签名对象
private List<Sign> signList;       //客户端签名对象列表

2. 客户端签署对象:Sign

此对象封装了人人法响应的相关签署的数据.

签署对象属性:

privateString signSn;          //签署唯一编号(人人法服务器生成)
privateString businessNum;     //签署唯一业务编号(用户服务器生成)
privatebyte[]signedPdf;        //签署完成后的 pdf 文件
privateint state;              //签署状态
privateStringqrcode;           //签署二维码数据
privateString creatTime;       //签署创建时间
privateString signTime;        //签署时间

3.客户端签署接口服务类:ElecSignService

包含电子签署相关的所有接口,即3.2.4, 3.2.5, 3.2.6 的所有接口

3.1 初始化:

new ElecSignService(String rrlServer, int port)

参数说明:

4.客户端签署相关接口

4.1 设置应用帐号 :setAccount

功能简介: 设置应用帐号。

原型:

public void setAccount(String appId, String appSecret)

参数说明:

4.2 设置合同模板数据 :setTemplate

功能简介: 设置合同模板数据。

原型:

public void setTemplate(String templateSn, String[]answers,boolean underline, Map<Integer, String[]> addTableContent)

参数说明:

参数示例:

String templateSn= "CT17040611593771672859858E5BD29D";
String[]answers= {"ZTTZ-10000703","2017 年 01 月 12 日","2017 年 03 月 12 日","张三"};
boolean underline=false;

4.3 设置签署数据 :setSignData

功能简介: 设置此次签署相关数据。

原型:

public void setSignData(String businessNum,int signType, String notifyUrl)

参数说明:

参数示例:

String businessNum="JKHT20161111";
int signType=3;
String notifyUrl="https://www.renrenlaw.com/sign/notify";

4.4 设置企业签章:setSealsOnCert

功能简介:设置企业签章数据,已经申请了企业签章证书。

原型:

public void setSealsOnCert(List<Map<String,Object>> sealList)

参数说明:

说明:参数 keyword 和 position 两者二选一,两个参数有且存在一个

参数示例:

String sealSn="CS17021416183335921148158A2BD598";
List<Map<String,Object>> sealList=new ArrayList<Map<String,Object>>();
Map<String,Object> certSeal=new TreeMap<String,Object>();
certSeal.put("companyName","北京人人法科技有限公司");
certSeal.put("sealSn", sealSn);
certSeal.put("keyword","丙方盖章:");

// certSeal.put("sealImg","dscvds9c8sdc87c8sdc7");

// List<Map<String,Object>> positionList=new ArrayList<Map<String,Object>>();
// Map<String,Object> positionMap=new TreeMap<String,Object>();
// positionMap.put("posX", 150);
// positionMap.put("posY", 500);
// positionMap.put("pageNum", 1);
// positionList.add(positionMap);
// certSeal.put("position", positionList);

certSeal.put("sealWidth","150");
certSeal.put("sealHeight","150");
certSeal.put("moveSize","-200");
certSeal.put("heightMoveSize","100");
certSeal.put("keywordType","1");
certSeal.put("searchOrder","2");
certSeal.put("coverType","2");
sealList.add(certSeal);

4.5 设置个人签字:setSignatures

功能简介: 设置个人签字数据。

原型:

public void setSignatures(List<Map<String,Object>> signatureList)

参数说明:

说明:参数 keyword 和 position 两者二选一,两个参数有且存在一个

参数示例:

List<Map<String,Object>> signatureList=new ArrayList<Map<String,Object>>();
Map<String,Object> signatureMap=new TreeMap<String,Object>();
signatureMap.put("name","张三");
signatureMap.put("idcard","421122188809298288383");
signatureMap.put("phone","17600000000");
signatureMap.put("keyword","甲方(出借人)签字");

// signatureMap.put("signature","cv9dvfdvfdv8df98v9d");

// List<Map<String,Object>> positionList=new ArrayList<Map<String,Object>>();
// Map<String,Object> positionMap=new TreeMap<String,Object>();
// positionMap.put("posX", 150);
// positionMap.put("posY", 500);
// positionMap.put("pageNum", 1);
// positionList.add(positionMap);
// certSeal.put("position", positionList);

signatureMap.put("sealWidth","150");
signatureMap.put("sealHeight","30");
signatureMap.put("moveSize","-450");
signatureMap.put("heightMoveSize","70");
signatureMap.put("keywordType","1");
signatureMap.put("searchOrder","1");
signatureMap.put("coverType","1");
signatureList.add(signatureMap);

4.6 完成签署 — 基于模板:signContractByTemplate

功能简介: 电子签署接口,基于模板完成签署。

原型:

public ClientMessage signContractByTemplate(String pdfSavePath)

参数说明:

4.7 完成签署 — 基于文件: signContractByFile

功能简介: 电子签署接口,基于文件完成签署。

原型:

public ClientMessage signContractByFile(String filePath ,String pdfSavePath)

参数说明:

4.8 完成签署 — 基于签署二维码:getSignatureQRcode

功能简介: 电子签署接口,基于生成的二维码,用户利用移动设备扫码进入完成签署。

原型:

public ClientMessage getSignatureQRcode()

返回数据:

调用接口后,会得到二维码的 base64 编码的数据,例如:

 `data:image/png;base64,R0lGODlhAwADAIABAL6+vv///yH5BAEAAAEALAAA`

使用:

 `<img src="data:image/png;base64,R0lGODlhAwADAIABAL" />`

二维码有效期为半个小时,超过半小时没有完成签署需要重新获取

4.9 完成签署 —重新获取签署二维码:getSignatureQRcodeAgain

功能简介: 电子签署接口,基于生成的二维码,用户利用移动设备扫码进入完成签署。

原型:

public ClientMessageget SignatureQRcodeAgain(StringsignSn)

参数说明:

5. 客户端查询接口

5.1 查询签署状态 :getSignState

功能简介: 查询合同的签署状态。

原型:

public ClientMessage getSignState(String signSn)

参数说明:

5.2查询单个合同:getSingleContract

功能简介: 查询单个合同。

原型:

public ClientMessage getSingleContract(String signSn)

参数说明:

6. 其他接口

6.1 发送签署验证码 :sendSignVerifyCode

功能简介: 签署前,发送手机验证码,调用签署接口完成签署时必需传入此验证码。

原型:

public ClientMessage sendSignVerifyCode(List<Map<String,Object>> phoneAndCodeList)

参数说明:

参数示例:

List<Map<String,Object>> codeList=new ArrayList<>();
Map<String,Object> codeMap=newHashMap<String,Object>();
codeMap.put("phone","18100000000");
codeMap.put("verifyCode","938720");
codeList.add(codeMap);