获取合同短链接

GET

/resrun-paas/kaifangqian/openAPI/V2/contract/pageUrl

根据合同id、任务id、操作人等信息查询合同短链接，若任务已办理完成或该操作人有权查看合同，则返回合同详情链接，若任务未办理，则返回待办任务链接；
2、用户打开链接查看合同详情或进行合同内容的完善、签署；
3、链接页面会自动检测终端，在手机端和电脑端会自动切换为h5和pc页面；
4、合同短链接增加免登录配置项，生成的短链接允许用户直接点击进入合同办理页面，无需进行登录验证。
5、若任务办理完成后，需要跳转到业务系统指定的页面，可在返回的短链接后自行拼接同步回调地址callbackPage，同步回调地址callbackPage需要进行编码。
以同步回调地址callbackPage为“https://baidu.com?code=001”为示例，
拼接示例：https://home.kaifangqian.com/#/contract/detail/base?code=PxfgSHB1&callbackPage=https%3A%2F%2Fbaidu.com%3Fcode%3D001
6、示例页面：以下以h5页面为示例
任务基本信息页面，用户根据页面引导，完成账号登录和身份确认，然后进入到合同详情页面或任务办理页面；

请求参数

Query 参数

uniqueCode

string

必需

不重复的流水号，随机生成即可，无状态，仅为了标识某笔请求，方便排查问题

示例值:

@guid

appAuthToken

string

应用授权凭证

必需

示例值:

contractId

string

必需

合同id，发起签署接口返回

taskId

string

可选

任务id，非必传，待办任务的id，可通过“获取合同待办任务”中获取

contact

string

必需

办理人账号，可以是该合同的发起人、签署人、抄送人、业务线指定查看人，支持邮箱和手机
注意：如果需要获取发起人的链接，则传递发起人的账号，如果需要获取其他签署人的链接，则传递对应签署人的账号。
不要使用发起人的账号为所有签署人获取链接，以免数据越权！

partyName

string

可选

办理方名称，若需要获取企业下某办理人的合同短链接，则需要传递对应的企业名称，若不传递，则只按照办理人信息查询

noLogin

integer

可选

是否免登录，0：否；1:是；不传默认为0；
若选择免登录，则生成的短链接打开后，直接免登录的方式跳转到任务办理页面；否则，打开链接后，需要登录后，才能跳转到任务办理页面；
免登录限制条件说明：当前办理人必须已经在电子签章平台注册账号并拥有对应待办任务的身份，否则，点击短链接后仍需要进行登录验证。

示例值:

pageUrlExpireTime

string

可选

免登录失效时间，不小于当前时间，当设置免登录方式时，该字段才生效。
格式：YYYY-MM-DD HH:MM:SS，示例：2028-01-01 00:00:00
免登录失效时间默认为72h，若传递，以传递的时间为准。
当到达免登录失效时间时，进入短链接需要重新登录，也可重新获取新的短链接。

Header 参数

sign

string

签名值，不校验

必需

默认值:

123456

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://home.kaifangqian.com/resrun-paas/kaifangqian/openAPI/V2/contract/pageUrl?uniqueCode=@guid&appAuthToken=&contractId&taskId&contact&partyName&noLogin=0&pageUrlExpireTime' \
--header 'sign;'

返回响应

🟢200成功

application/json

Body

code

integer

返回码

必需

10000成功，其他参见附录

message

string

返回描述

必需

返回描述，不可用于流程控制

result

object

返回的结果数据

可选

pageUrl

string

合同短链接URL

可选

合同短链接URL

timestamp

integer

时间戳

可选

时间戳

示例

{
    "code": 0,
    "message": "string",
    "result": {
        "pageUrl": "string"
    },
    "timestamp": 0
}

发起签署

获取合同待办任务