接口说明
创建合同签署流程
API 方法名:nuonuo.eleConShortcutSign.createContractSignProced 版本:V2.0
请求地址
| 环境 | 请求地址 |
|---|
| 正式环境 | https://sdk.nuonuo.com/open/v1/services |
| 沙箱环境 | https://sandbox.nuonuocs.cn/open/v1/services |
公共请求参数(消息头)
| 参数名 | 类型 | 必填 | 长度 | 说明 | 示例 |
|---|
| Content-type | String | 否 | - | MIME类型【消息头】 | - |
公共请求参数(消息体)
| 参数名 | 类型 | 必填 | 长度 | 说明 | 示例 |
|---|
| senid | String | 否 | - | 唯一标识,由企业自己生成32位随机码【消息体】 | - |
私有请求参数
| 参数名 | 类型 | 必填 | 长度 | 说明 | 示例 |
|---|
| application | String | 否 | - | 应用名称,请联系对接人员分配 | 测试应用 |
| originatorType | Number | 否 | - | 发起方账户类型。 0:个人 1:企业 | 0 |
| originatorAccountId | String | 否 | - | 发起人账户id | 6b134df519184011111111132e2fa5c |
| originatorPartId | String | 否 | - | 发起人主体id。当originType=0时,originatorAccountId和originatorPartId必须相同 | 6b134df519184011111111132e2fa5c |
| contractName | String | 否 | 80 | 合同名称 | 合同名称 |
| contractFileId | String | 是 | 255 | 合同文件id,上传合同接口返回的id。模板发起合同则非必填 | 合同id |
| redirectUrl | String | 是 | - | 签署完成定向地址。默认签署完成停在当前页面,即不跳转。 | - |
| deadline | String | 是 | - | 合同签署截止时间,yyyy-MM-dd 格式。不传默认为2099-12-31 | 2020-12-31 10:00:00 |
| notifyUrl | String | 是 | - | 合同回调通知地址。当合同状态和签署者状态发生变化时,会以post方式并将参数以json的形式放入请求体中回调接口。 status:合同状态(1签署中,2已完成,3已过期,4已作废),签署者状态(1签署中,2已完成)。注意:回调接口需以{“code”:200}格式的数据以响应成功,否则会认为接口回调失败,回调失败后,在合同状态没有再次变化的前提下,每间隔5分钟重新回调一次,最多回调5次。 | 示例:http://***.com/notify 通知参数:{"contractNo":"32132131","status":1,"changeTime":"2020-01-01 12:00:00","contractSigns":[{"signatoryId":"签署人id","signatoryName":"签署人名称","signatoryEnterpriseName":"签署企业名称","status":1}]} |
| templateId | Number | 是 | - | 合同模板id,使用模板发起时必填 | 333 |
| templateOriginType | Number | 是 | - | 合同模板来源。 0:saas模版 1:快捷签模版,使用模版发起时若不填则默认saas模版 | 1 |
| version | Number | 是 | - | 合同模板版本号,使用模板发起时必填 | 1 |
| fieldList | Array | 是 | - | 模版字段数组。如果模板中设置了文本框/日期框/单选框/复选框字段,并且设置了必须输入,那么该字段不能为空。 | - |
| └ fieldId | Number | 否 | - | 字段id | 10158 |
| └ content | String | 是 | - | 文本框或日期框填写的内容,若为日期框,则日期格式为yyyy-MM-dd | 模版内容 |
| └ options | Array | 是 | - | 单、复选框选项选中的内容,字符串组成的数组 | ["杭州","宁波"] |
| smsOpenFlag | Number | 是 | - | 短信消息通知配置(0关闭、1短信 默认为0)包括合同签署完成、签署截止通知 | 1 |
| attachmentList | Array | 是 | - | 合同附件, 最多支持6个,非必填 | - |
| └ attachmentFileId | String | 否 | - | 附件文件id | 2887650316-31b2db094c0a407392d54714b111ec0f |
| contractUserNo | String | 是 | - | 合同编号(用户自定义合同编号) | 36 |
响应参数
| 参数名 | 类型 | 必填 | 长度 | 说明 | 示例 |
|---|
| code | String | 否 | - | 返回码(H200:成功; H99999:请求异常或服务器异常; H88888:参数异常) | H200 |
| describe | String | 否 | - | 描述,当接口发生错误时,有值。 | 应用不合法 |
| result | String | 否 | - | 流程编号 | aaaaa1223 |
请求报文示例
NNOpenSDK sdk = NNOpenSDK.getIntance();
String taxnum = "23***789"; // 授权企业税号
String appKey = "Hn***XL";
String appSecret = "F65***65F";
String method = "nuonuo.eleConShortcutSign.createContractSignProced"; // API方法名
String token = "2d484e**************pdui"; // 访问令牌
String content = "{
\"originatorAccountId\": \"6b134df519184011111111132e2fa5c\",
\"redirectUrl\": \"\",
\"contractFileId\": \"合同id\",
\"templateId\": 333,
\"version\": 1,
\"smsOpenFlag\": 1,
\"application\": \"测试应用\",
\"attachmentList\": [
{
\"attachmentFileId\": \"2887650316-31b2db094c0a407392d54714b111ec0f\"
}
],
\"templateOriginType\": 1,
\"notifyUrl\": \"示例:http://***.com/notify 通知参数:{\\"contractNo\\":\\"32132131\\",\\"status\\":1,\\"changeTime\\":\\"2020-01-01 12:00:00\\",\\"contractSigns\\":[{\\"signatoryId\\":\\"签署人id\\",\\"signatoryName\\":\\"签署人名称\\",\\"signatoryEnterpriseName\\":\\"签署企业名称\\",\\"status\\":1}]}\",
\"contractName\": \"合同名称\",
\"contractUserNo\": \"36\",
\"deadline\": \"2020-12-31 10:00:00\",
\"fieldList\": [
{
\"options\": [
\"[\\"杭州\\"\",
\"\\"宁波\\"]\"
],
\"content\": \"模版内容\",
\"fieldId\": 10158
}
],
\"originatorType\": 0,
\"originatorPartId\": \"6b134df519184011111111132e2fa5c\"
}";
String url = "https://sdk.nuonuo.com/open/v1/services"; // SDK请求地址
String senid = UUID.randomUUID().toString().replace("-", ""); // 唯一标识,32位随机码,无需修改,保持默认即可
String result = sdk.sendPostSyncRequest(url, senid, appKey, appSecret, token, taxnum, method, content);
System.out.println(result);
返回码说明
| 返回码 | 说明 | 处理建议 |
|---|
H200 | 成功 | |
H88888 | 参数异常 | 检查入参 |
H99999 | 系统异常 | 根据提示原因或联系管理员解决 |