有方信息
  • 文档
  • YFD101
有方信息
2023-03-10
目录

BS SDK接口文档

# 变更说明

修改编号 版本 修改内容 修改人 修改日期
1 1.0 1.0版本创建 HHF 2022/6/13

# 使用说明

# 服务地址

http://127.0.0.1:28810/ http://localhost:28810/

# 通信协议

http

# 字符编码

UTF-8

# 公共参数

公共参数是用于标识用户接口的参数

参数名称 类型 必选 描述
action int 是 具体操作的指令的接口编号
ret int 是 响应报文对请求功能的返回值描述

# 发送

提示

所有请求参数需要经过Base64进行编码

用户请求连接的形式举例：

{
  "action": 1
}

实际需要发送的数据：

eyJhY3Rpb24iOjF9

# 接收

接收到的数据：

eyJhY3Rpb24iOjEsInJldCI6MH0=

Base64解码

{
  "action": 1,
  "ret": 0
}

# 服务接口说明

# 获取设备状态

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 1 接口操作码

输出参数

参数名称 类型 数据约束 描述
action int 1 接口操作码
ret int 0 成功
-1 失败

# 屏保页添加

输入参数

提示

输入参数需要经过Base64编码后发送到接口

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 16 接口操作码
PicPath string 绝对路径 待机图片绝对路径(最佳尺寸1280*800)
ChangeTime string 屏保切换时间（单位秒）

输出参数

参数名称 类型 数据约束 描述
action int 16 接口操作码
ret int 0 成功
-1 失败

# 屏保页删除

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 30 接口操作码
PicPath string 需要删除的文件名称（包括后缀, -1 删除全部设置的待机图片）
ChangeTime string 屏保切换时间（单位秒）

输出参数

参数名称 类型 数据约束 描述
action int 30 接口操作码
ret int 0 成功
-1 失败

# 取消操作

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 35 接口操作码

输出参数

参数名称 类型 数据约束 描述
action int 35 接口操作码
ret int 0 成功
-1 失败

# 设备升级

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 36 接口操作码
filepath String 绝对路径 设备软件文件（可使用.zip压缩升级）

输出参数

参数名称 类型 数据约束 描述
action int 36 接口操作码
ret int 0 成功
-1 失败

# 获取设备版本号信息

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 27 接口操作码

输出参数

参数名称 类型 数据约束 描述
action int 27 接口操作码
RetR string 版本号
ret int 0 成功
-1 失败

# 获取设备SN号信息

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 28 接口操作码

输出参数

参数名称 类型 数据约束 描述
action int 28 接口操作码
RetR string SN号
ret int 0 成功
-1 失败

# PDF预览确认

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 45 接口操作码
PdfPath String 本地路径 pdf绝对路径
time int 超时时间 单位秒

输出参数

参数名称 类型 数据约束 描述
action int 45 接口操作码
detail string 0 确认 -1取消
ret Int 0 成功
-1 失败

# 单签字

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 03 接口操作码
PagesEvaluatorTime Int 超时时间 单位秒

输出参数

参数名称 类型 数据约束 描述
action int 03 接口操作码
signImg String Base64 签字图片base64数据
detail string 0 确认 -1取消
ret Int 0 成功
-1 失败

# 单指纹

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 04 接口操作码
PagesEvaluatorTime Int 超时时间 单位秒

输出参数

参数名称 类型 数据约束 描述
action int 04 接口操作码
signImg String Base64 签字图片base64数据
detail string 0 确认 -1取消
ret Int 0 成功
-1 失败

# 打开摄像头

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 43 接口操作码

输出参数

参数名称 类型 数据约束 描述
action int 43 接口操作码
ret Int 0 成功
-1 失败
url String http://127.0.0.1:28810/video=0&date=1666918505448( (opens new window)

# 关闭摄像头信息

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 44 接口操作码

输出参数

参数名称 类型 数据约束 描述
action int 44 接口操作码
ret Int 0 成功
-1 失败

# 开始录像

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 49 接口操作码

输出参数

参数名称 类型 数据约束 描述
action int 49 接口操作码
ret Int 0 成功
-1 失败

# 停止录像

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 50 接口操作码
url String 文件保存后上传服务器url地址

输出参数

参数名称 类型 数据约束 描述
action int 50 接口操作码
ret Int 0 成功
-1 失败
upRet int 0 上传服务器结果 0 成功
-1 上传服务器结果 -1失败
path string 视频本地存储绝对路径

# 拍照

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 51 接口操作码

输出参数

参数名称 类型 数据约束 描述
action int 51 接口操作码
ret Int 0 成功
-1 失败
photographImg Base64 jpg 拍照base64图片jpg
path string 图片本地存储绝对路径

# Pdf签字

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 48 接口操作码
PdfPath String 本地路径 pdf绝对路径
time int 超时时间 单位秒

输出参数

参数名称 类型 数据约束 描述
action int 48 接口操作码
signPdf String Base64 签字PDFbase64数据
detail string 0 确认 -1取消
ret Int 0 成功
-1 失败

# 签字指纹合成

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 10 接口操作码
path1 String 图片1 指纹或签字图片(图片1在上)
Path1 string 图片2 指纹或签字图片(图片2在下)

输出参数

参数名称 类型 数据约束 描述
action int 10 接口操作码
signFingerImg String Base64 合成图片base64数据
ret Int 0 成功
-1 失败

# 表单

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 11 接口操作码
type Int 1-4 1-3设置内置表单 4上位机设置表单
time Int 0-1800 超时时间 小于或等于0 不超时 其他设置超时

输出参数

参数名称 类型 数据约束 描述
action int 11 接口操作码
imgBase64 String Base64 合成图片base64数据
ret Int 0 成功
-1 失败

# 人证比对

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 52 接口操作码

输出参数

参数名称 类型 数据约束 描述
action int 52 接口操作码
backImg String Base64 身份证背面图片
frontImg String Base64 身份证正面图片
faceImg String Base64 人脸照片
idImg String Base64 身份证照片
idCardInfo Json Json 身份证信息json字符串 详见19.3
ret Int 0 比对成功
-1 比对失败
  ### idCardInfo**输出参数**
参数名称 类型 数据约束 描述
address String 住址
birthday String 出生日期
endDate String 结束有效期
fpdata String 指纹特征(需身份证中带指纹特征)
gender String 性别
idCardNumber String 身份证号
maker String 发证机关
name String 姓名
national String 民族
startData String 开始有效期

# 活体检测

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 53 接口操作码

输出参数

参数名称 类型 数据约束 描述
action int 53 接口操作码
faceImg String Base64 人脸照片
ret Int 0 比对成功
-1 比对失败

# 身份证读取

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 54 接口操作码

输出参数

参数名称 类型 数据约束 描述
action int 54 接口操作码
backImg String Base64 身份证背面图片
frontImg String Base64 身份证正面图片
idImg String Base64 身份证照片
idCardInfo Json Json 身份证信息json字符串 详见19.3
ret Int 0 比对成功
-1 比对失败

# Xml笔记回显

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 9 接口操作码

输出参数

参数名称 类型 数据约束 描述
action int 9 接口操作码
ret Int 0 比对成功
-1 比对失败

# 叫号信息

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 55 接口操作码
name String 姓名
call String 工号
number String 叫号编码
path String 员工照片路径

输出参数

参数名称 类型 数据约束 描述
action int 55 接口操作码
ret Int 0 成功
-1 失败

# 叫号信息

输入参数

提示

输入参数需要经过Base64编码后发送到接口

参数名称 类型 数据约束 描述
action int 56 接口操作码
type String 0-3 0-手机号,1-金额,2-密码
time String 超时时间

输出参数

参数名称 类型 数据约束 描述
action int 56 接口操作码
value String 用户输入字符串
ret Int 0 成功
-1 失败

# 错误码

错误码 错误信息
0 成功
-1 失败
-2 断开设备连接!
-3 取消操作或主动断开设备连接!
-4 接收指令长度异常!
-5 当前指令未结束,取消操作可结束当前指令!
-6 准备发送的文件不存在!
-7 字符串为空
-8 base64文件数据为空
-9 未知指令
-10 依赖dll未找到！
上次更新: 2023/03/11, 09:20:51
CS SDK接口文档
Android开发文档

← Android开发文档→

Theme by Vdoing | Copyright © 2018-2023 Haveways | 粤ICP备18079728号-1

×