接口描述
当发起企业授权书签署任务成功后,根据授权ID可以通过接口获取授权书签署的链接。
接口地址
点击下述蓝色字体{host}可跳转至API请求域名说明文档
https://{host}/v1/signAuthApi/signUrl
请求方式
POST
请求数据格式
application/json; charset=UTF-8
请求参数
参数名称 | 参数位置 | 参数类型 | 必选 | 参数说明 |
authId | Body | string | 是 | 授权流程ID |
needLogin | Body | boolean | 否 | 是否需要登录打开链接,默认值 true true - 需登录打开链接,false - 免登录 |
clientType | Body | string | 否 | 指定客户端类型,默认值 :ALL H5 - 移动端适配 PC - PC端适配 ALL - 自动适配移动端或PC端(默认值) 【注】参数值均为大写的英文 |
redirectUrl | Body | string | 否 | 授权签署完成后跳转页面,重定向到平台指定页面 |
appScheme | Body | string | 否 | AppScheme,用于唤起App。 示例值:esign://demo/signBack |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | |
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | |
message | string | 否 | 业务信息 请根据 code 来判断错误情况,不应该依赖 message 匹配,因为 message 可能会调整。 | |
data(点击“+”展开详情) | object | 否 | 业务数据 | |
shortUrl | string | 否 | 授权流程签署短链接, 默认需要登录实名(登录和实名是e签宝SaaS官网的注册实名),链接90天内有效 | |
longUrl | string | 否 | 授权流程签署长链接, 默认需要登录实名(登录和实名是e签宝SaaS官网的注册实名),链接90天内有效 |
请求示例
{
"authId": "5ab3d62ce9b******bf3712505",
"needLogin": false,
"clientType": "ALL",
"redirectUrl": "https://open.esign.cn"
}
响应示例
{
"code": 0,
"message": "成功",
"data": {
"longUrl": "https://smlh5.esign.cn/mesign/guide?context=oBm2rNc9iV&flowId=2feffb21*****ed8cbe44dc2fea0775&organ=true&appId=7438850755&linkSource=1&bizType=1&tsign_source_type=SIGN_LINK_WUKONG&tsign_source_detail=16R2mv%2F27h2Y5CkM9bwhboFnISBv4A96Mcbu325ELx2eLwL%2Bpv%2FrKexnQYU4pTsQrdx3R5lsaACcqXwJGEdAY22bsvcLec262U0qdPanoxfzxsX2U%2FTAxQH38E9UZ62LDh2O6oB0FNR58bFP1LhDnSukP0jnPTC3eedLchNFJc5X084ny1bdRQDmX2cROuI%2BIEXJCADwUXlz2m4yzWNFHZXA0K0G4w5ORnTi4XBkOKozjg3mf9c10rnNZVfYK2OXf",
"shortUrl": "https://smlt.esign.cn/oN3htAv"
}
}