1.0 合同签署
纽业态<个人合同签署>接口文档
1.1 合同初始化
简要描述
- 根据用户 ID,初始化合同
请求 URL
/task/openapi/v1/contract/init
请求方式
- POST
返回类型
- JSON
请求参数说明
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
userId | 是 | Long | 用户ID |
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
contractCode | string | 合同编号 |
contractUrl | string | 合同预览地址 |
请求参数示例
[528]
正确返回示例
{
"msg": "请求成功",
"code": "200",
"success": true,
"data": {
"contractCode": "202012240001",//合同模版
"contractUrl": "https://{domain}/contract/xxxx"//合同预览地址
}
}
错误返回示例
{
"msg": "参数缺失",
"code": "010001",
"success": false,
"data": null
}
备注
1.2 合同签署
简要描述
- 根据签名,生成正式合同。
请求 URL
/task/openapi/v1/contract/signer
请求方式
- POST
返回类型
- JSON
请求参数说明
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
contractCode | 是 | String | 合同编号(1.1接口返回参数) |
signerUrl | 是 | String | 个人签名图片地址 (调用方匿名可访问地址,图片格式:PNG, 图片大小:3MB) |
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
contractCode | String | 合同编号 |
contractUrl | String | 合同地址 |
contractStatus | Integer | 合同状态 1.未签署 2.签署中 3.已签署 |
正确返回示例
{
"msg": "请求成功",
"code": "200",
"success": true,
"data": {
"contractCode": "202012240001",
"contractUrl": "https://{domain}/contract/xxxx",
"contractStatus": 1
}
}
备注
1.3 个人合同查询
简要描述
- 查询个人合同信息
请求 URL
/task/openapi/v1/contract/info
请求方式
- GET
返回类型
- JSON
请求参数说明
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
userId | 是 | Long | 用户ID |
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
contractCode | String | 合同编号 |
contractUrl | String | 合同访问地址 |
contractStartTime | String | 合同开始时间 |
contractEndTime | String | 合同结束时间 |
contractStatus | Integer | 合同状态 |
firstName | String | 甲方名称 |
secondName | String | 乙方名称 |
正确返回示例
{
"msg": "请求成功",
"code": "200",
"success": true,
"data": {
"contractCode": "202012240001",
"contractUrl": "https://{domain}/contract/xxxx",
"contractStartTime": "2020-12-24",
"contractEndTime": "",
"contractStatus": 1,
"firstName": "纽业态(上海)信息科技有限公司",
"secondName": "张三"
}
}
备注
- 更多返回错误代码请看首页的错误代码描述