DONSEE东信智能 - 身份证社保卡读卡智能终端应用服务商

广东东信智能科技有限公司DONSEE EST-100多功能手写签批屏开发文档，包括了手写签字、指纹采集、读身份证、社保卡、IC卡、银行卡、高拍仪、人脸识别比对等多种功能。

SDK开发包下载地址：

1、EST-100签批屏SDK开发包下载↓

产品销售咨询：138-2221-6429

鸿蒙技术咨询：139-2221-0502

东信智能多功能签批屏Web浏览器接口

用户开发手册

修订人 修订日期 修订内容

何工 2025-03-27 支持PDF关键字签字、PDF任意签字、获取PDF签字图片、人像采集、高拍采集、身份证读取、指纹采集、获取签字图片

1.使用说明

1.1.服务地址

Url：ws://127.0.0.1:30089

1． 通信协议

API的所有接口均通过 WebSocket进行通信

2．请求方式

请求方式： json 文本

3． 字符编码

均使用UTF-8 编码

4． 公共参数

公共参数是用于表示用户和接口目的的参数

参数名称 类型 必选 描述

action string 是 具体操作的指令的接口编号

ret string 是 响应报文对请求功能的返回值描述

用户请求连接的形式举例,将请求参数封装成 json 字符串发送

{“action”: “50”}

响应报文描述实例：

{“action”: “50”, “ret”: “00”}

2.服务接口说明

2.1. 打开设备连接

2.1.1 输入参数

参数名称 类型 数据约束 描述

action string donsee_01

2.1.2 输出参数

参数名称 类型 数据约束 描述

action string donsee_01

ret string 00 设备连接成功

   01 设备连接失败

2.2. 断开设备连接

2.2.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_02

2.1输出参数

参数名称 类型 数据约束 描述

action string donsee_02

ret string 00 设备断开连接成功

   01 设备断开连接失败

2.3. 获取设备序列号

2.3.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_03

2.3.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_03

SN string 设备序列号

ret string 00 成功

   01 失败

2.4. 写设备序列号

2.4.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_04

SN string 序列号

2.4.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_04

ret string 00 成功

   01 失败

2.5. 写首页背景

2.5.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_05

imgPath string 首页背景图片路径

2.5.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_05

ret string 00 成功

   01 失败

2.6. 重置首页背景

2.6.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_61

2.6.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_61

ret string 00 成功

   01 失败

2.7.设置签字板标题

2.7.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_06

title string 签字板标题

2.7.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_06

ret string 00 成功

   01 失败

2.8.设置笔颜色

2.8.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_07

color int RGBA格式 签字笔颜色，例如0xFF0000FF 红色

2.8.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_07

ret string 00 成功

   01 失败

2.9. 设置笔压

2.9.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_08

pressure float 笔压范围: 0.1~1.0

2.9.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_08

ret string 00 成功

   01 失败

2.10. 设置签字框位置

2.10.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_09

x int x起点

y int y起点

width int 宽度

height int 高度

2.10.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_09

ret string 00 成功

   01 失败

2.11.设置边框

2.11.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_10

type int 边框宽度

2.11.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_10

ret string 00 成功

   01 失败

2.12.设置边框颜色

2.12.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_11

color int RGBA格式 边框颜色，例如0xFF0000FF 红色

2.12.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_11

ret string 00 成功

   01 失败

2.13.设置签字笔宽度

2.13.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_12

width int 签字图片宽度

2.13.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_12

ret string 00 成功

   01 失败

2.14.设置签字笔高度

2.14.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_13

height int 签字图片高度

2.14.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_13

ret string 00 成功

   01 失败

2.15.开始签字

2.15.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_14

2.15.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_14

ret string 00 成功

   01 失败

2.16.重签

2.16.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_15

2.16.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_15

ret string 00 成功

   01 失败

2.17.关闭签字版

2.17.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_16

2.17.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_16

ret string 00 成功

   01 失败

2.18.获取签字笔迹轨迹图片路径

2.18.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_17

2.18.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_17

path string 签字图片保存路径

ret string 00 成功

   01 失败

2.19.获取签字笔迹轨迹图片

2.19.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_18

2.19.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_18

path string 签字图片保存路径

ret string 00 成功

   02 等待客户端确认签字

   01 失败

2.20.获取签字图片base64

2.20.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_19

2.20.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_19

imgBase64 string 签字图片

ret string 00 成功

   01 失败

2.21.保存签字图片

2.21.1. 输入参数

参数名称 类型 数据约束 描述

action string donsee_20

2.21.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_20

path string 签字图片路径

ret string 00 成功

   01 失败

2.22.打开摄像头

2.22.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_21

index int 摄像头索引，例如0、1、2

width int 宽

height int 高

2.22.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_21

ret string 00 成功

   01 失败

2.23.拍照（保存图片路径）

2.23.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_22

index int 摄像头索引

2.23.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_22

path string 拍照图片路径

ret string 00 成功

   01 失败

2.24.拍照图片base64

2.24.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_23

index int 摄像头索引

2.24.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_23

imgBase64 string 拍照图片

width int 拍照图片宽

height int 拍照图片高

ret string 00 成功

   01 失败

2.25. 关闭摄像头

2.25.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_24

index int 摄像头索引

2.25.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_24

ret string 00 成功

   01 失败

2.26. 获取摄像头个数

2.26.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_25

2.26.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_25

count int 摄像头个数

ret string 00 成功

   01 失败

2.27.获取摄像头名称（遍历所有摄像头）

2.27.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_26

2.27.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_26

cameraNames stringArr 摄像头分辨率，二维数组形式[[“320x480”,”640x480”], [“320x480”, “640x480”]]

ret string 00 成功

   01 失败

2.28.获取当前摄像头分辨率

2.28.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_28

2.28.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_28

width int 宽

height int 高

ret string 00 成功

   01 失败

2.29.旋转

2.29.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_29

2.29.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_29

ret string 00 成功

   01 失败

2.30.沿x轴翻转

2.30.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_30

2.30.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_30

ret string 00 成功

   01 失败

2.31.沿y轴翻转

2.31.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_31

2.31.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_31

ret string 00 成功

   01 失败

2.32.开启自动裁剪

2.32.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_32

2.32.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_32

ret string 00 成功

   01 失败

2.33.关闭自动裁剪

2.33.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_33

2.33.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_33

ret string 00 成功

   01 失败

2.34.缩小

2.34.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_34

2.34.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_34

ret string 00 成功

   01 失败

2.35.放大

2.35.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_35

2.35.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_35

ret string 00 成功

   01 失败

2.36.设置预览回调

2.36.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_36

2.36.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_36

imgBase64 string 仅当 ret=”00” 时才有数据

ret string 00 成功

   02 等待预览数据

   01 失败

2.37.图片转base64

2.37.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_37

path string 图片路径

2.37.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_37

imgBase64 string 图片base64数据

ret string 00 成功

   01 失败

2.38.图片合成PDF

2.38.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_38

imgArrary stringArr 图片数组，例如[“xxx.jpg”, “xxx.jpg”]

keepRatio int 是否缩放0: 保持原始比例，0: 不处理、1：以宽为基准、2：以高为基准

fullPage int 是否缩放到整页，0: 不缩放 1:填充整个页面

paddingLeft int 左边距

paddingTop int 上边距

paddingRight int 右边距

paddingBottom int 底边距

2.38.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_38

pdfPath string pdf路径

ret string 00 成功

   01 失败

2.39.读身份证

2.39.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_40

2.39.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_40

idInfo string 身份证信息，以|分割

ret string 00 成功

   02 等待用户刷身份证

   01 失败

2.40.读身份证头像

2.40.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_41

2.40.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_41

photoData string hexString 身份证头像数据

ret string 00 成功

   01 失败

2.41.读身份证指纹

2.41.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_60

2.41.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_60

finData string hexString 身份证头像数据

ret string 00 成功

   01 失败

2.42.停止读取身份证

2.42.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_42

2.42.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_42

ret string 00 成功

   01 失败

2.43.读取条码信息

2.43.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_43

2.43.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_43

barcode string 条码数据

ret string 00 成功

   01 失败

2.44.读取指纹

2.44.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_44

2.44.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_44

imgBase64 string 指纹图片base64

ret string 00 成功

   02 等待按压指纹

   01 失败

2.45.关闭读取指纹

2.45.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_46

2.45.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_46

ret string 00 成功

   01 失败

2.46.发起PDF签字（任意签）

2.46.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_47

pdfData string pdf数据

pdfType 为0 是传入PDF文件路径。

1：时传入 pdf base64

pdfType number 0:  pdfFile, 1: pdfBase64

timeout string 签字操作时间

2.46.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_47

pdfBase64 pdf签字后base64文件

SignNameJson string 签字JSON

SignNameCount int 签字的个数

FinPrintJson string 指纹JSON

FinPrintCount int 指纹的个数

XMLJson string 签字轨迹JSON

XMLCount int 签字轨迹个数

ret string 00 成功

   02 正在下载PDF

   03 等待用户操作完成

   04 签字超时

   01 失败

2.47.发起网络PDF签字（任意签）

2.47.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_147

downloadPath string 下载地址

uploadPath string 上传地址

userId string 可选 用户id

key string key

timeout number 签字操作时间

2.47.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_147

ret string 00 成功

   02 正在下载PDF

   03 等待用户完成操作

   04 PDF签字超时

   05 上传失败

   01 失败

2.48. 关闭PDF签字

2.48.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_48

2.48.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_48

ret string 00 成功

   01 失败

2.49.打开评价器

2.49.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_49

2.49.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_49

value string 评价结果: 1:非常满意、2:满意、3:一般、4:不满意、5:非常不满意

ret string 00 成功

   02 等待用户完成评价

   01 失败

2.50. 关闭评价

2.50.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_50

2.50.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_50

ret string 00 成功

   01 失败

2.51.PDF关键字签字

2.51.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_51

timeout int 操作时间

compose int 签名是否需要合成, 1： 合成到指定页面、2：仅展示不合成

width int 签字宽度占页面的百分比

height int 签字高度占页面的百分比

keyword stringArr 关键字数组，例如[“申请人签字”,”受访者签字”]

keywordCnt int 关键字个数，既数组长度

title string 签字标题

pdfData string pdf数据

根据pdfType选择，0：文件，1：base64

pdfType number 0: pdfFile 1: pdf base64

2.51.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_51

SignPdfBase64 string pdf签字后base64

SignNameBase64 string 签字图片base64

FinPngBase64 string 指纹图片base64，可能为空

ret string 00 成功

   02 正在下载PDF

   03 等待用户完成操作

2.52.PDF网络关键字签字

2.52.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_151

timeout int 操作时间

compose int 签名是否需要合成, 1： 合成到指定页面、2：仅展示不合成

width int 签字宽度占页面的百分比

height int 签字高度占页面的百分比

keyword stringArr 关键字数组，例如[“申请人签字”,”受访者签字”]

keywordCnt int 关键字个数，既数组长度

title string 签字标题

downloadPath string 下载接口地址

uploadPath string 上传地址

userId string 用户ID

key string key秘钥

2.52.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_151

SignNameBase64 string 签字图片base64

FinPngBase64 string 指纹图片base64，可能为空

ret string 00 成功

   02 正在下载PDF

   03 等待用户完成操作

   04 PDF签字超时

   05 上传失败

   01 失败

2.53.关闭PDF关键字签字

2.53.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_52

2.53.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_52

ret string 00 完成

   01 失败

2.54.发起图片签字

2.54.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_53

timeout int 操作时间

compose int 是否合成到图片上，1: 合成、2:仅展示不合成

left int 签字位置距离图片起始位置百分比

top int 签字位置距离图片左上角百分比

titile string 签字标题

imgPath string JPG图片路径

2.54.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_53

imgBase64 string 签字后的图片base64

singImgBase64 string 签字图片base64

ret string 00 成功

   02 等待用户签字完成

   01 失败

2.55.关闭图片签字

2.55.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_54

2.55.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_54

ret string 00 成功

   01 失败

2.56.读取社保卡信息

2.56.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_57

2.56.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_57

sscardInfo string 社保卡信息，以|分割

ret string 00 成功

   02 等待用户刷社保卡

   01 失败

2.57.基于加密机的读卡步骤一

2.58.输入参数

参数名称 类型 数据约束 描述

action string donsee_58

2.58.1.输出参数

参数名称 类型 数据约束 描述

action string donsee_58

sscardInfo string 社保卡信息，以|分割

ret string 00 成功

   01 失败

2.59.基于加密机的读卡步骤二

2.60.输入参数

参数名称 类型 数据约束 描述

action string donsee_59

pKey string pKey

2.60.1.输出参数

参数名称 类型 数据约束 描述

action string donsee_59

sscardInfo string 社保卡信息，以|分割

ret string 00 成功

   01 失败

2.61.关闭社保卡读取

2.62.输入参数

参数名称 类型 数据约束 描述

action string donsee_60

2.62.1.输出参数

参数名称 类型 数据约束 描述

action string donsee_60

ret string 00 成功

   01 失败

2.63.打开网页

2.64.输入参数

参数名称 类型 数据约束 描述

action string donsee_165

2.64.1.输出参数

参数名称 类型 数据约束 描述

action string donsee_165

ret string 00 成功

   01 失败

2.65.关闭网页

2.66.输入参数

参数名称 类型 数据约束 描述

action string donsee_166

2.66.1.输出参数

参数名称 类型 数据约束 描述

action string donsee_166

ret string 00 成功

   01 失败

2.67.更新APK

2.67.1.输入参数

参数名称 类型 数据约束 描述

action string donsee_62

apkPath string 不为空                    apk文件路径

2.67.2.输出参数

参数名称 类型 数据约束 描述

action string donsee_62

ret string 00 成功

   01 失败