获取签署地址

更新时间：2022-10-27 10:25:29

接口描述

流程开启后，获取指定签署人的签署链接地址。

如仅传入签署人账号id（accountId），则获取的签署任务链接仅包含本人的签署任务；
如同时签署人账号id（accountId）+机构id（organizeId），则获取的签署任务链接包含企业与个人的签署任务。

API在线调试

可通过API在线调试工具使用接口功能，入口：获取签署地址

接口

/v1/signflows/{flowId}/executeUrl

请求方式

GET

请求头

提供两种安全接入方式，开发者可选择其中一种方式进行对接，对应参数如何获取，参考文档【请点击】。

方式一：请求签名鉴权（优先推荐）

请求头入参示例如下：

参数名称	类型	必选	参数说明
X-Tsign-Open-App-Id	string	是	应用ID
Content-Type	string	是	application/json;charset=UTF-8
X-Tsign-Open-Ca-Timestamp	string	是	API 调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟，为了防重放攻击
Accept	string	是	建议统一填写 /
X-Tsign-Open-Ca-Signature	string	是	签名字符串
Content-MD5	string	是	当请求 Body 非 Form 表单时，可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时，加上此请求头。
X-Tsign-Open-Auth-Mode	string	是	选择请求方式进行鉴权，固定值，Signature

方式二：OAuth2.0鉴权（不推荐使用）

当安全接入选择OAuth2.0鉴权方式，请点击查阅详情，请求头入参示例如下：

参数名称	类型	必选	参数说明
X-Tsign-Open-App-Id	string	是	应用ID
X-Tsign-Open-Token	string	是	通过获取鉴权Token接口返回
Content-Type	string	是	application/json; charset=UTF-8

请求参数

参数名称	类型	必选	参数类型	参数说明
flowId	string	是	path	流程id
accountId	string	是	query	签署人账号id
organizeId	string	否	query	默认为空，返回的任务链接仅包含签署人本人需要签署的任务；传入0，则返回的任务链接包含签署人“本人+所有代签机构”的签署任务；传入指定机构id，则返回的任务链接包含签署人“本人+指定代签机构”的签署任务。
urlType	int32	否	query	链接类型（默认0） 0 -签署链接;1 -预览链接
appScheme	string	否	query	app Scheme 示例：appScheme=esign://demo/signBack

公共响应参数

参数名称	类型	必选	参数说明
code	int	是	业务码，0表示成功
message	string	否	信息
data	object	否	业务信息

响应参数

参数名称	类型	必选	参数说明
shortUrl	string	否	短链地址（180天有效）
url	string	否	长链地址(永久有效)

请求示例

GET https://openapi.esign.cn/v1/signflows/b2cb74258a634179b0df3cc54791c8b6/executeUrl?accountId=24c93459216945468fdf1d899c521910&organizeId=2c7de24aff3340f5b944ebac49545b8e

响应示例

{
  "code": 0,
  "message": "成功",
  "data": {
    "url": "http://testfront.tsign.cn:8821?context=mby8thwTJVcRhE8MbAUeYHiV0CoxNbGaCZz%2BzOIZxwPW8zZEyzddjDvu63OR%2BhpgEUp7Ys4DVub%2BiSQfldmCTC89MbdDHUUZ4yvgRXCjQ6s0Dcznr4daT4v9vR6SSKJsmrRIc%2F3xudxk6DmsqcmQSl0UJGwVCo%2FGFRG6bkjCuCSuVkESLfyf0iqgJqIuy8yYkxdWe%2Fi52IEJwFH%2FclDwS8Vb27mTop5HcuAAWaOUPKw2hTXCeLkx9zWgS4HOW17H8%2F%2BL6NtuWgiglUbedhpsdjgpEoQr63J%2FcXytIoFtDMvXmgZKnrN3QCuNBbS63QGuP5qHESNvyHbsd5qVkzy%2FzUSk7I4boumxkCFcDxXofKJ0SUahJTazovg031vx7uoXZT2kSW%2B9JhDN9rs8mbXCEs01VYiCiUP6hd81lHX%2B9jdFTJqELbE%2BDkBpUcCBJjbhME84qqoZDRTDHzQkxjOk3Ztbp3URjIFqpA9vAN%2FylLwzT0oyf3nirv7I%2BYBr8Qcr&flowId=b2cb74258a634179b0df3cc54791c8b6&organ=true",
    "shortUrl": "https://testt.tsign.cn/55vebd3omU7k"
  }
}

错误码

错误码	错误描述	解决方案
1437101	流程不存在	流程id不存在
1437105	流程已删除	流程已被删除
1437103	流程尚未启动	流程还是草稿状态, 未发起
1437114	XXX不是流程参与人, 无权查看流程	当前用户不是流程参与人 1.如果是个人签署，accountId需要传当前签署流程的个人签署账号。 2.如果是企业签署，accountid需要传当前签署的经办人账号，organizeId需要传当前签署的机构账号或者直接传0。