启动H5页面签署

websocket测试

GET

接口描述

页面URL拼接”signType=1“参数为简洁签署页(简洁页无签名列表管理功能)；签署链接有效期为10分钟。

描述

- 测试环境地址：https://fat-yss-h5.myrrx.com/signFilePage - 正式环境地址：https://h5.ecloudsign.com/signFilePage ==关于callBack、wxCallBack说明== callBack：该参数是签署完成后回调的页面，这种方式下签署完成后会自动跳转，传callBack的情况下，++**wxCallBack字段会自动失效**++ wxCallBack：该参数是签署完后显示的按钮 “**返回小程序**”按钮被点击时回调到小程序的路径配置如果 **callBack** 和 **wxCallBack** 都不传，签署完成后会显示 “**查看文件**”按钮， “**查看文件**”按钮可以跳转到合同详情页，但无法再回调，++**不建议使用**++

请求URL示例

```language https://fat-yss-h5.myrrx.com/signFilePage?telephone=XXX&contractNum=XXX&signPosition=XXX&timestamp=XXX&appKey=XXX&v=1.0&secret=XXX&cardType=XXX&idCardNum=XXX&name=XXX&isFinish=XXX&type=XXX&callBack=XXX ```

公共请求参数

参数名

类型

描述

必填

appKey

String

appKey

必填

secret

String

密钥

必填

timestamp

String

时间戳 "2021-01-18 14:56:12"

必填

String

版本号 "1.0"

必填

业务请求参数

参数名

类型

描述

必填

telephone

String

手机号

必填

contractNum

String

合同编号

必填

signPosition

String

签章信息，格式详见下方举例；若合同非模板方式创建请传入空字符串

必填

cardType

String

证件类型 0：身份证 1：军官证 ,2：护照、3：驾驶证、4：工商登记证、5：税务登记证、6：组织机构代码、7：其他证件，8：统一社会信用代码

必填

idCardNum

String

证件号

必填

name

String

姓名

必填

isFinish

String

合同是否签署完成(0:是,1:否),例如合同属于双方合同，第一个人签署时，isFinish 否，当第二个签署时候，参数isFinish为是

必填

callBack

String

签署成功后自动跳转的回调跳转地址

可选

wxCallBack

{"username":"gh_4563384079a7","path":""}，“返回小程序” 按钮回调小程序配置

可选

smscode

是否发送验证码，不传默认是true

可选

signPosition数据格式示例

```language [ { "positionName": 1, //如果合同非模版方式创建无需传参 "signId": 1 //印章或签名id，非必填，不填时用默认印章 } ] ```

请求加密方式说明

- 将公共参数与业务参数（除appKey、callBack、wxCallBack,smscode、signType外）进行加密后拼接，采用aes加密方式进行加密；其中aes加密密钥在开放平台的产品列表中，与appkey获取方式一致 - callBack（回调地址）参数需进行转义后拼接，callBack不传签署完成跳转查看签署详情页面 `可使用encodeURIComponent() 方法进行转义`

JAVA加密方法示例

```language /** * aes加密 * @param str * @param key * @return * @throws Exception */ public static String aesEncrypt(String str, String key) throws Exception { if (str == null || key == null) return null; Cipher cipher = Cipher.getInstance("AES/ECB/PKCS5Padding"); cipher.init(Cipher.ENCRYPT_MODE, new SecretKeySpec(key.getBytes("utf-8"), "AES")); byte[] bytes = cipher.doFinal(str.getBytes("utf- 8")); //注意不要采用，会出现回车换行 new BASE64Encoder().encode(bytes); return Base64.encodeBase64String(bytes); } ```