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

更新时间:2025-05-16 17:52:46

接口描述

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

接口名称

AuthService.getAuthFlowUrl(AuthFlowSignUrlParam authFlowSignUrlParam)

请求参数

展开全部参数参数名称

类型

必选

参数说明

authFlowSignUrlParam

AuthFlowSignUrlParam

获取签署链接的参数

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

响应参数

展开全部参数参数名称

类型

必选

参数说明

authFlowSignUrlResult

AuthFlowSignUrlResult

响应结果类

errCode

int

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

msg

String

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

errorShow

boolean

错误信息是否建议显示

authId

String

授权流程ID

shortUrl

String

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

longUrl

String

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

请求示例  

// 获取客户端的代码:
ServiceClient getKHD = ServiceClientManager.get(ConfigConstant.PROJECT_ID);

/** 获取授权签署任务链接 */
AuthFlowSignUrlParam authFlowSignUrlParam = new AuthFlowSignUrlParam();
authFlowSignUrlParam.setAuthId("1751111394725122050");//授权流程ID
authFlowSignUrlParam.setNeedLogin(false);//是否需要登录打开链接:true - 需登录打开链接,false - 免登录
authFlowSignUrlParam.setRedirectUrl("https://open.esign.cn");//重定向跳转地址
authFlowSignUrlParam.setClientType("ALL");//指定客户端类型,默认值 :ALL ; H5 - 移动端适配 , PC - PC端适配 , ALL - 自动适配移动端或PC端
AuthFlowSignUrlResult getAuthFlowUrlResult = getKHD.authService().getAuthFlowUrl(authFlowSignUrlParam);

if (getAuthFlowUrlResult.getErrCode() != 0)
    System.out.println("获取授权签署任务链接失败:" + JSONObject.fromObject(getAuthFlowUrlResult));
else
    System.out.println("获取授权签署任务链接成功," + JSONObject.fromObject(getAuthFlowUrlResult));

响应示例

{
    "msg": "成功",
    "errCode": 0,
    "shortUrl": "https://smlt.esign.cn/TlKCBQs",
    "errShow": false,
    "longUrl": "http://smlt.esign.cn/mesign/guide?context=GfqzTzB&flowId=fe4bf216880e4717a65bec57945b4b58&organ=true&appId=3438757903&linkSource=1&bizType=1&tsign_source_type=SIGN_LINK_WUKONG&tsign_source_detail=1dD1NfAAcu6I1%2BcZbDyz2N0fW%2FotE7VQRoRph%2BGH386zdb58u%2F3Fa7KKEMJuByhPpGltydgT2%2FfJ5xLUyx9dygTC8Cw97vtpM4RnBXh0yZQbGFoCIZ5M%2FuIWN8NPOOa3Qnxn8y7Y7qI%2BFVZWJbrg%2FVm6LVl2chzaGZBDA%2ByLt8snDYkT8kTyTIi9owtMzhEo%2Bop%2BFGRNbSeNaFx3oB54lvsk79a0BtwnQ4xpZW2klU6MaEsqpV4w7KHOlN2wIOLYk",
    "authId": "1751111394725122050"
}


我要纠错