亲笔签SDK在线文档

Appearance

大纲

API ​

实例初始化 ​

init(options) ​

初始化笔迹 SDK

  • 参数： init 参数结构说明
参数名参数类型是否必传参数描述
hoststring否访问后台服务地址
headersObject否访问后台服务请求头
  • 示例代码
javascript
<script src="https://open.isigning.cn/handwriting-sdk/umd/isigning.base.js"></script>
<script>
  var handwritingSDK = window.axBaseLib.init({
    host: '',
    headers: {
    }
  })
</script>

实例 / 方法 ​

startSign(options) ​

开始签字(拉起签字板，将控制交给签字板)

  • 参数： startSign 参数结构说明
参数名参数类型是否必传参数描述
optionsobject否签字板配置项
-- signTypestring否值：TOUCH_SCROLL 开启长文本签署
-- logoboolean|string否是否启用 logo，字符串可配置 logo 图片内容
-- tipTextstring否左上区域提示文案
-- watermarkstring否右下区域提示文案
tokenstring是token
signDistinguishboolean否是否开启签字校验,默认 false
beforeHashstring否签字之前文件的 hash 值

  • 返回值：void

  • 示例代码

js
handwritingSDK.startSign({
  options: {
    signType: "",
    logo: "",
    tipText: "",
    noteContent: ""
  },
  token: "",
  signDistinguish: true,
  beforeHash: ""
});

signLogin(options) ​

签字登录

  • 参数： signLogin 参数结构说明
参数名参数类型是否必传参数描述
tokenstring是token

  • 返回值：void

  • 示例代码

js
handwritingSDK.signLogin({
  token: "",
});

startSignSample(options) ​

开始签字留样

参数名参数类型是否必传参数描述
tokenstring是token
optionsobject否签字板配置项
-- countnumber否留样次数，默认 5 次，可选值 1-5
-- logoboolean|string否是否启用 logo，字符串可配置 logo 图片内容
-- tipTextstring否左上区域提示文案
-- watermarkstring否右下区域提示文案
modestring否留样模式，可选：singleStep(单步留样)/continuity(连续留样)，默认连续留样模式
countnumber否留样次数，默认 5 次，可选值 1-5
hasHandwritingModelingboolean否是否需要笔迹建模，默认为 true，如果不清楚带来的后果请不要修改该值
isResetnumber否是否重新留样，1：重新，0：首次留样，默认 0

  • 返回值：void

  • 示例代码

js
handwritingSDK.startSignSample({
  token: "",
  mode: "continuity",
  count: 5,
  hasHandwritingModeling: true
});

resetBatchSample([personIdentity]) ​

重置留样数据，该方法仅在单步留样模式下生效

参数名参数类型是否必传参数描述
personIdentitystring否签署人证件号码，如果不传默认清空本地临时缓存的所有留样记录，
有则清除指定留样人记录

返回值 void

  • 示例代码
js
handwritingSDK.resetBatchSample();

closeSign() ​

关闭签字界面

  • 返回值：void

  • 示例代码

js
handwritingSDK.closeSign();

preview(options) ​

获取签字笔迹图片

参数名参数类型是否必传参数描述
tokenstring是token
idstring是需要预览的资源 ID，印章 = sealImagesId， 签字 = handwritingImageId

  • 返回值：Stream（文件流）

  • 示例代码

js
handwritingSDK.preview({
  token: "",
  id: ""
});

finishSign(options) ​

完成签字(将签署之前、之后的文件 hash 与签字笔迹进行绑定，后台存证)

参数名参数类型是否必传参数描述
tokenstring是token
beforeHashstring否签字之前文件的 hash 值
afterHashstring否签字之后文件的 hash 值
thirdBizIdstring是第三方业务流水号
hashAlgorithmstring否文件 hash 签名算法（md5|sm3）
payloadstring是sign-complete 事件返回的 payload 字段

注意事项：

如果 beforeHash、afterHash、hashAlgorithm 有任意一个值则三个字段都必填

  • 返回值：Promise
js
handwritingSDK.finishSign({
  token: "",
  beforeHash: "",
  afterHash: "",
  thirdBizId: "",
  hashAlgorithm: "",
  payload: ""
});

contentValidation(options) ​

参数名参数类型是否必传参数描述
tokenstring是token
contentstring是传入的内容进行校验，字符长度1-50
containerHTMLElement是append 内容区域
typenumber是默认传入：1
thirdBizIdstring是第三方业务流水号
abortValidationCallbackfunction否中断校验的回调
successCallbackfunction否校验完成的回调

注意事项：

  1. 请注意 container 的背景颜色，可能会存在穿模的情况。
  2. content 支持：中文（必填）、英文字母（大小写）、数字、标点符号：,.!?（中英文皆支持）

实例 / 事件 ​

sign-complete ​

签字完成

  • 回调参数：options: ISignCompleteOptions
ts
interface ISignCompleteOptions {
  // 签字笔迹图片base64
  handwritingImage: string;
  // 签字笔迹图片ID，后续可通过ID获取签字笔迹图片
  handwritingImageId: string;
  // 签字流程ID，签字校验成功后返回
  flowId: string | undefined;
  // 部分需要finishSign事件携带的数据
  payload: string;
}
  • 示例：
js
handwritingSDK.on("sign-complete", options => {
  const { handwritingImage, handwritingImageId, payload } = options;
  // 签字完成执行逻辑
});

sign-close ​

签字关闭（所有签字关闭的效果都会触发）

  • 示例：
js
handwritingSDK.on("sign-close", () => {
  // 签字关闭执行逻辑
});

sign-cancel ​

签字取消 （仅取消签署触发）

  • 示例：
js
handwritingSDK.on("sign-cancel", () => {
  // 签字取消执行逻辑
});

sign-verify-error ​

笔迹验证异常（签字笔迹校验时触发）

  • 示例：
js
handwritingSDK.on("sign-verify-error", e => {});

sign-verify-success ​

笔迹验证通过

  • 示例：
js
handwritingSDK.on("sign-verify-success", e => {});

sample-complete ​

留样完成

  • 示例：
js
handwritingSDK.on("sample-complete", data => {
  // handwritingImages [string] 留样图片base64数组
  // handwritingImageIds [string] 留样图片id数组
});

sample-error ​

留样异常

  • 示例：
js
handwritingSDK.on("sample-error", e => {
  // e 错误对象
});

Copyright © 2019-present Aoscript