类 FileSignClient
- java.lang.Object
-
- com.dss.sdk.api.base.BaseApi
-
- com.dss.sdk.api.client.FileSignClient
-
public class FileSignClient extends BaseApi
- 作者:
- Fadada
-
-
字段概要
-
从类继承的字段 com.dss.sdk.api.base.BaseApi
clientService
-
-
构造器概要
构造器 构造器 说明 FileSignClient(DssClientService clientService)
-
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 DssResponse<FaceSignResponse>faceSign(FaceSignRequest faceSignRequest)POST /api/sign/verify/face/url : 文件签署(刷脸校验) 接口说明:对文件进行电子签名,支持把需要加盖的电子签名及证书,加盖到指定的签署位置。DssResponse<FilePreviewUrlResponse>filePreviewUrl(FilePreviewUrlRequest previewUrlRequest)EUI-获取文件预览页DssResponse<FileSignSignResponse>fileSignAcross(FileSignSignRequest fileSignSignRequest)POST /api/file/sign/across : 骑缝章签署DssResponse<FileBatchSignResponse>fileSignBatch(FileBatchSignRequest batchSignRequest)POST /api/file/sign/batch : 批量文件签署DssResponse<FileSignListResponse>fileSignList(FileSignListRequest request)查询文件签署记录DssResponse<FileSignSignResponse>fileSignRemark(FileSignSignRequest fileSignSignRequest)POST /api/file/sign/remark : 备注签署DssResponse<FileSignSignResponse>fileSignSign(FileSignSignRequest fileSignSignRequest)POST /fileSign/sign : 文件签署 接口说明:对文件进行电子签名,支持把需要加盖的电子签名及证书,加盖到指定的签署位置。DssResponse<FileSignUrlResponse>fileSignUrl(FileSignUrlRequest request)DssResponse<FileSignVerifyResponse>fileSignVerify(FileSignVerifyRequest request)DssResponse<Boolean>sendSms(SendSmsRequest sendSmsRequest)POST /api/sign/verify/sms/send : 获取签署短信验证码 接口说明 接口说明:调用该接口可以向指定手机号发送短信验证码 适用场景:1、需要验证码做意愿校验的场景,获取验证码后,使用相同的transactionId调用[文件签署]接口,并回填短信验证码。DssResponse<FileSignResultResponse>signResultQuery(SignRequestQueryRequest request)POST /api/file/sign/result : EUI-查询文件签署结果 接口说明 特别说明: 1、此接口将用于EUI文件签署场景下,通过transactionId查询文件签署结果。DssResponse<VerifyResultResponse>verifyResult(VerifyResultRequest verifyResultRequest)POST /api/sign/verify/result : 查询意愿校验结果 接口说明: 使用[文件签署-支持刷脸校验][文件签署-支持互动视频校验]接口时,主动查询意愿校验结果DssResponse<VideoSignResponse>videoSign(VideoSignRequest videoSignRequest)POST /api/sign/verify/video/url : 文件签署(刷脸校验) 接口说明:对文件进行电子签名,支持把需要加盖的电子签名及证书,加盖到指定的签署位置。
-
-
-
构造器详细资料
-
FileSignClient
public FileSignClient(DssClientService clientService)
-
-
方法详细资料
-
fileSignSign
public DssResponse<FileSignSignResponse> fileSignSign(FileSignSignRequest fileSignSignRequest) throws ApiException
POST /fileSign/sign : 文件签署 接口说明:对文件进行电子签名,支持把需要加盖的电子签名及证书,加盖到指定的签署位置。支持电子印章、日期章、骑缝章及签署备注。 适用场景:对最终确认签署的电子文件(PDF/OFD)进行电子签名。- 参数:
fileSignSignRequest- (optional)- 返回:
- 成功 (status code 200)
- 抛出:
ApiException
-
fileSignAcross
public DssResponse<FileSignSignResponse> fileSignAcross(FileSignSignRequest fileSignSignRequest) throws ApiException
POST /api/file/sign/across : 骑缝章签署- 参数:
fileSignSignRequest-- 返回:
- 抛出:
ApiException
-
fileSignRemark
public DssResponse<FileSignSignResponse> fileSignRemark(FileSignSignRequest fileSignSignRequest) throws ApiException
POST /api/file/sign/remark : 备注签署- 参数:
fileSignSignRequest-- 返回:
- 抛出:
ApiException
-
sendSms
public DssResponse<Boolean> sendSms(SendSmsRequest sendSmsRequest) throws ApiException
POST /api/sign/verify/sms/send : 获取签署短信验证码 接口说明 接口说明:调用该接口可以向指定手机号发送短信验证码 适用场景:1、需要验证码做意愿校验的场景,获取验证码后,使用相同的transactionId调用[文件签署]接口,并回填短信验证码。 特别说明:1、允许相同transactionId多次调用获取验证码接口,每次调用返回不同的验证码,仅最新的验证码有效。 2、同一个transactionId获取验证码后,文件签署时必须回填验证码,否则不能完成签署- 参数:
sendSmsRequest- (optional)- 返回:
- 成功 (status code 200)
- 抛出:
ApiException
-
faceSign
public DssResponse<FaceSignResponse> faceSign(FaceSignRequest faceSignRequest) throws ApiException
POST /api/sign/verify/face/url : 文件签署(刷脸校验) 接口说明:对文件进行电子签名,支持把需要加盖的电子签名及证书,加盖到指定的签署位置。支持电子印章、日期章、骑缝章及签署备注。 适用场景:1、适用于使用刷脸做意愿校验签署文件场景。 注意事项: 1、确保签署的印章内容和证书主体的信息保持一致,避免纠纷。 2、平台方确认用户签署时的真实意愿后,再调用此接口完成签章。- 参数:
faceSignRequest- (optional)- 返回:
- 成功 (status code 200)
- 抛出:
ApiException
-
videoSign
public DssResponse<VideoSignResponse> videoSign(VideoSignRequest videoSignRequest) throws ApiException
POST /api/sign/verify/video/url : 文件签署(刷脸校验) 接口说明:对文件进行电子签名,支持把需要加盖的电子签名及证书,加盖到指定的签署位置。支持电子印章、日期章、骑缝章及签署备注。 适用场景:1、适用于使用刷脸做意愿校验签署文件场景。 注意事项: 1、确保签署的印章内容和证书主体的信息保持一致,避免纠纷。 2、平台方确认用户签署时的真实意愿后,再调用此接口完成签章。- 参数:
videoSignRequest- (optional)- 返回:
- 成功 (status code 200)
- 抛出:
ApiException
-
verifyResult
public DssResponse<VerifyResultResponse> verifyResult(VerifyResultRequest verifyResultRequest) throws ApiException
POST /api/sign/verify/result : 查询意愿校验结果 接口说明: 使用[文件签署-支持刷脸校验][文件签署-支持互动视频校验]接口时,主动查询意愿校验结果- 参数:
verifyResultRequest- (optional)- 返回:
- 成功 (status code 200)
- 抛出:
ApiException
-
fileSignBatch
public DssResponse<FileBatchSignResponse> fileSignBatch(FileBatchSignRequest batchSignRequest) throws ApiException
POST /api/file/sign/batch : 批量文件签署- 抛出:
ApiException
-
fileSignList
public DssResponse<FileSignListResponse> fileSignList(FileSignListRequest request) throws ApiException
查询文件签署记录- 抛出:
ApiException
-
filePreviewUrl
public DssResponse<FilePreviewUrlResponse> filePreviewUrl(FilePreviewUrlRequest previewUrlRequest) throws ApiException
EUI-获取文件预览页- 抛出:
ApiException
-
fileSignUrl
public DssResponse<FileSignUrlResponse> fileSignUrl(FileSignUrlRequest request) throws ApiException
- 抛出:
ApiException
-
fileSignVerify
public DssResponse<FileSignVerifyResponse> fileSignVerify(FileSignVerifyRequest request) throws ApiException
- 抛出:
ApiException
-
signResultQuery
public DssResponse<FileSignResultResponse> signResultQuery(SignRequestQueryRequest request) throws ApiException
POST /api/file/sign/result : EUI-查询文件签署结果 接口说明 特别说明: 1、此接口将用于EUI文件签署场景下,通过transactionId查询文件签署结果。 适用场景: 1、适用于需要查询文件签署记录的场景。 注意事项: 1、通过transactionId可以查询出单次签署记录。- 参数:
request-- 返回:
- 抛出:
ApiException
-
-