Skip to content

获取合同签署链接 ​

接口说明 ​

仅返回当前 key 创建的合同签署链接。一份合同返回:

  • signUrl:短链。打开后可「前往小程序」或点「在浏览器中签署」
  • h5SignUrl:浏览器 H5 直达链接(正式 m.xwkc.com,测试 h5dev.xwkc.com)

全体签署方可任选其一。只发短链即可同时覆盖小程序与浏览器。

返回条件:合同状态为 signing,且链接尚未失效。失效时刻取以下三者中最早的一个:创建后 30 天、合同截止时间、合同离开进行中的时刻。不满足条件时返回 40900。

平台不代发短信或微信,请由接入方将链接自行通知签署方。

请求地址:/open/v1/contracts/{contractId}/sign-url

请求方式:GET

在线调试

请求参数 ​

每个请求须携带请求头 X-Api-Key。

参数名称数据类型必须说明
contractId
string是
合同 ID,路径参数

响应参数 ​

参数名称数据类型必须说明
code
number是
0 表示成功
message
string是
说明
data
object是
业务数据
contractId
string是
合同 ID
signUrl
string是
微信小程序签署引导短链
h5SignUrl
string是
浏览器 H5 签署链接。正式 m.xwkc.com,测试 h5dev.xwkc.com

响应示例 ​

json
{
  "code": 0,
  "message": "ok",
  "data": {
    "contractId": "ct_20001",
    "signUrl": "https://h5.xwkc.com/r8k2mQ",
    "h5SignUrl": "https://m.xwkc.com/#/ePackage/pages/contractDetail/index?taskId=ct_20001&sceneCon=personShare"
  }
}

开放平台开发者中心