接口说明
商家平台可以调用该接口动态获取在电子合同平台生成的合同的列表信息。
API 方法名:nuonuo.electronicContract.contractListQuery 版本:V2.0
请求地址
| 环境 | 请求地址 |
|---|
| 正式环境 | https://sdk.nuonuo.com/open/v1/services |
| 沙箱环境 | https://sandbox.nuonuocs.cn/open/v1/services |
公共请求参数(消息头)
| 参数名 | 类型 | 必填 | 长度 | 说明 | 示例 |
|---|
| Content-type | String | 否 | - | MIME类型【消息头】 | - |
公共请求参数(消息体)
| 参数名 | 类型 | 必填 | 长度 | 说明 | 示例 |
|---|
| senid | String | 否 | - | 唯一标识,由企业自己生成32位随机码【消息体】 | - |
私有请求参数
| 参数名 | 类型 | 必填 | 长度 | 说明 | 示例 |
|---|
| taxNum | String | 否 | 20 | 企业税号 | 330111111222220523a2 |
| contractStatus | Number | 是 | 2 | 合同状态:不传查询全部,传2查询已完成的合同 | 2 |
| pageNum | Number | 否 | 10 | 当前页(最小为1,最大不能超过最大页) | 1 |
| pageSize | Number | 否 | 10 | 每页条数(10~100之间) | 10 |
| createTimeStart | String | 是 | - | 合同创建时间 -开始 yyyy-MM-dd hh:mm:ss | 2019-07-01 15:11:56 |
| createTimeEnd | String | 是 | - | 合同创建时间 -结束 yyyy-MM-dd hh:mm:ss | 2019-08-01 15:11:56 |
| conSignType | Number | 是 | - | 合同签订方式 0 全部 , 1 电子签署 2 纸质签署 默认1 | 0 |
| statusChangeTimeStart | String | 是 | - | 合同状态变化时间 -开始 yyyy-MM-dd hh:mm:ss | 2019-07-01 15:11:56 |
| statusChangeTimeEnd | String | 是 | - | 合同状态变化时间 -结束 yyyy-MM-dd hh:mm:ss | 2019-08-01 15:11:56 |
响应参数
| 参数名 | 类型 | 必填 | 长度 | 说明 | 示例 |
|---|
| totalCount | Number | 否 | - | 总条数 | 18 |
| data | Array | 否 | - | 合同列表数据 | 如下 |
| └ contractNo | String | 否 | - | 合同编号 | 2019070115115526621135731 |
| └ contractName | String | 否 | - | 合同名称 | 发起合同接口测试1 |
| └ status | Number | 否 | - | 合同状态:1签署中,2已完成,3已过期,4已作废5作废中 | 2 |
| └ createTime | String | 否 | - | 合同创建时间 | 2019-07-01 15:11:56 |
| └ signatoryTime | String | 否 | - | 合同签署时间 | 2019-07-01 15:34:15 |
| └ contractSignType | Number | 否 | - | 合同签订方式 0:电子合同 1:纸质归档 | 0 |
请求报文示例
NNOpenSDK sdk = NNOpenSDK.getIntance();
String taxnum = "23***789"; // 授权企业税号
String appKey = "Hn***XL";
String appSecret = "F65***65F";
String method = "nuonuo.electronicContract.contractListQuery"; // API方法名
String token = "2d484e**************pdui"; // 访问令牌
String content = "{
\"conSignType\": 0,
\"contractStatus\": 2,
\"statusChangeTimeStart\": \"2019-07-01 15:11:56\",
\"createTimeEnd\": \"2019-08-01 15:11:56\",
\"pageSize\": 10,
\"statusChangeTimeEnd\": \"2019-08-01 15:11:56\",
\"taxNum\": \"330111111222220523a2\",
\"createTimeStart\": \"2019-07-01 15:11:56\",
\"pageNum\": 1
}";
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);
响应报文示例
{
"code": "H200",
"describe": "成功",
"result": {
"totalCount": 18,
"data": [{
"contractNo": "2019070115115526621135731",
"contractName": "发起合同接口测试1",
"status": 2,
"createTime": "2019-07-01 15:11:56",
"signatoryTime": "2019-07-01 15:34:15"
}]
}
}
返回码说明
| 返回码 | 说明 | 处理建议 |
|---|
H200 | 请求成功 | 无需处理 |
H10102 | 传入的税号与请求者的税号不一致 | 请检查传入的税号 |
H10106 | 系统出错 | 请稍后重试 |
H10107 | 参数有误 | 根据具体的提示处理 |