1.0-合同签署
纽业态<个人合同签署>接口文档,按照不同的业务流程,一个人可能需要签署多份合同,接口只需要调用一次,系统后台同时签署多份合同
1.1 合同初始化
简要描述
- 根据用户 ID,初始化合同
请求 URL
/task/openapi/v1/contract/init
请求方式
- POST
返回类型
- JSON
请求参数说明
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
userId | 是 | Long | 用户ID |
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
contractCode | String | 合同编号 |
contractType | String | 合同类型: 10 纽业态合同 80 衡阳自由职业者服务协议 |
contractInitUrl | String | 合同预览地址 |
请求参数示例
{
"userId":78955
}
正确返回示例
{
"msg": "请求成功",
"code": "200",
"success": true,
"data":
[
{
"contractCode": "202012240001",//合同编码
"contractType": "10",//合同类型
"contractUrl": "https://task.alitatest.cn/anon/file/download/c4b7197f0c234592aede3d65b8129299"//合同预览地址
},
{
"contractCode": "合同编码",//合同编码
"contractType": "80",//合同类型
"contractUrl": "合同预览地址"//合同预览地址
}
]
}
错误返回示例
{
"msg": "参数缺失",
"code": "010001",
"success": false,
"data": null
}
备注
1.2 合同签署
简要描述
- 根据签名,生成正式合同。
请求 URL
/task/openapi/v1/contract/sign
请求方式
- POST
返回类型
- JSON
请求参数说明
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
userId | 是 | Long | 用户ID |
signerUrl | 否 | String | 个人签名图片地址 (调用方匿名可访问地址,图片格式:PNG, 最大图片:3MB,若为空时系统按照用户姓名默认生成个人签章图片) |
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
contractCode | String | 合同编号 |
contractType | String | 合同类型: 10 纽业态合同 80 衡阳自由职业者服务协议 |
contractStatus | String | 合同状态 1:初始化 2:签署中 3:签署成功 4:签署失败 5:合同过期 |
请求参数示例
{
"userId":78955,
"signerUrl": "https://task.alitatest.cn/anon/file/download/fec96d58a69e4a0cacac65b9c22e205c"
}
正确返回示例
{
"msg": "请求成功",
"code": "200",
"success": true,
"data":
[
{
"contractCode": "CS20210531000001",
"contractStatus": "1",
"contractType": "10" //合同类型
},
{
"contractCode": "CS20210531000002",
"contractStatus": "1",
"contractType": "80" //合同类型
}
]
}
备注
1.3 个人合同查询
简要描述
- 查询个人合同信息
请求 URL
/task/openapi/v1/contract/info
请求方式
- GET
返回类型
- JSON
请求参数说明
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
userId | 是 | Long | 用户ID |
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
contractCode | String | 合同编号 |
contractUrl | String | 合同访问地址 |
contractType | String | 合同类型: 10 纽业态合同 80 衡阳自由职业者服务协议 |
contractStartDate | String | 合同开始时间 (格式 YYYY-MM-DD) |
contractEndDate | String | 合同结束时间 (格式 YYYY-MM-DD) |
contractStatus | String | 合同状态 1:初始化 2:签署中 3:签署成功 4:签署失败 5:合同过期 |
firstName | String | 甲方名称 |
secondName | String | 乙方名称 |
请求参数示例
{
"userId":78955
}
正确返回示例
{
"requestId": "9f91a22bfff77cd5",
"msg": "请求成功",
"code": "200",
"success": true,
"data":
[
{
"contractCode": "CS20210526000001",
"contractType": "10" //合同类型
"contractUrl": "https://task.alitatest.cn/anon/file/download/c4b7197f0c234592aede3d65b8129299",
"contractStartDate": "2021-05-26",
"contractEndDate": null,
"contractStatus": "1",
"firstName": "鑫业态平台机构",
"secondName": "于永虹"
},
{
"contractCode": "CS20210526000002",
"contractType": "80" //合同类型
"contractUrl": "https://task.alitatest.cn/anon/file/download/c4b7197f0c234592aede3d65b8129299",
"contractStartDate": "2021-05-26",
"contractEndDate": null,
"contractStatus": "1",
"firstName": "鑫业态平台机构",
"secondName": "于永虹"
}
]
}
备注
- 更多返回错误代码请看首页的错误代码描述