【线上】获取授权签署任务链接

更新时间:2024-04-15 11:30:18

接口描述

当发起企业授权书签署任务成功后,根据授权ID可以通过接口获取授权书签署的链接。

接口地址

http://ip:port/paas-sdk-service/timevale/auth/getAuthFlowUrl

请求方式

POST

请求数据格式

application/json; charset=UTF-8

请求参数

参数名称

类型

必选

参数说明

authId

string

授权流程ID

needLogin

boolean

是否需要登录打开链接,默认值 true

true - 需登录打开链接,false - 免登录

clientType

string

指定客户端类型,默认值 :ALL

H5 - 移动端适配

PC - PC端适配

ALL - 自动适配移动端或PC端(默认值)

【注】参数值均为大写的英文

redirectUrl

string

授权签署完成后跳转页面,重定向到平台指定页面

appScheme

string

AppScheme,用于唤起App。

示例值:esign://demo/signBack

响应参数

参数名称

类型

必选

参数说明

errCode

int

错误码,0标识成功,其他均标识失败

msg

string

错误信息,错误码对应的说明信息

errorShow

boolean

错误信息是否建议显示

authId

string

授权流程ID

shortUrl

string

授权流程签署短链接, 默认需要登录实名(登录和实名是e签宝SaaS官网的注册实名),链接90天内有效

longUrl

string

授权流程签署长链接, 默认需要登录实名(登录和实名是e签宝SaaS官网的注册实名),链接90天内有效

请求示例  

{
    "authId": "171200088877777222",
    "needLogin": false,
    "clientType": "ALL",
    "redirectUrl": "https://open.esign.cn"
}

响应示例

{
    "msg": "成功",
    "errCode": 0,
    "shortUrl": "https://smlt.esign.cn/nVANyyy",
    "errShow": false,
    "longUrl": "https://smlh5.esign.cn/mesign/guide?context=HzDdvCn&flowId=d1507f8daefb49c222222f&organ=true&appId=7438850755&linkSource=1&bizType=1&tsign_source_type=SIGN_LINK_WUKONG&tsign_source_detail=16R2mv%2F27h2Y5CkM9bwhboFnISBv4A96Mcbu325ELx2eLwL%2Bpv%2FrKexnQYU4pTsQrdx3R5lsaACcqXwJGEdAY22bsvcLec262U0qdPanoxfzxsX2U%2FTAxQH38E9UZ62LDh2O6oB0FNR58bFP1LhDnSukP0jnPTC3eedLchNFJc5X084ny1bdRQDmX2cROuI%2BIFlxgEvtUR7bOyNjQa7nxBhdnHhUloFhyty0UKTOeIleyKOLKd3gfx3HzjAb3qRdE",
    "authId": "171200088877777222"
}


我要纠错