有方信息
  • 文档
  • YF1016
有方信息
2023-02-28
目录

BS SDK接口文档

# YF1016 SDK接口文档

产品名称 YF1016(HID)
当前版本号 1.0.0

# 使用说明

# 服务地址：

http://127.0.0.1:28810

# 通信协议：

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

# 请求方式

POST

# 字符编码

UTF-8

# 公共参数

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

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

用户请求连接的形式举例：（请求参数需要经过Base64加密）

{"action": "50"}

响应报文描述实例：

{"action": "50", "ret": "00"}

# 跨域请求参数

处理浏览器跨域去请求问题而设置的报文头参数

参数 参数设置 必选 描述
Access-Control-Allow-Origin http://127.0.0.1:28810 (opens new window) 是
Access-Control-Allow-Headers origin,x-requested-with,token,content-type 是
Access-Constrol-Max-Age 1800 是
Access-Control-Allow-Methods True 是

# 服务接口说明

# 打开设备连接

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 01

# 输出参数

参数名称 类型 数据约束 描述
action string 01
ret string 00 设备连接成功
01 设备连接失败

# 断开设备连接

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 02

# 输出参数

参数名称 类型 数据约束 描述
action string 02
ret string 00 设备断开连接成功
01 设备断开连接失败

# 设置pdf保存路径

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 03
Path string 设置pdf需要保存的路径

# 输出参数

参数名称 类型 数据约束 描述
action string 03
ret string 00 Pdf保存路径设置成功
01 Pdf保存路径设置失败

# 传入pdf并打开

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 04
PdfPath string Pdf的文件路径
PdfPathTime string 阅读时间

# 输出参数

参数名称 类型 数据约束 描述
action string 04
result string -1 用户取消
00 用户确定
-2 操作超时
ret string 00 Pdf打开成功
01 Pdf打开失败

# 获取设备状态

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 05

# 输出参数

参数名称 类型 数据约束 描述
action string 05
state string 设备状态代码
ret string 00 设备状态获取成功
01 设备状态获取失败

# 获取签字的pdfbase64（输入pdf路径）

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 06
SignPdfPath string 需要签字的pdf 的路径

# 输出参数

参数名称 类型 数据约束 描述
action string 06
result string -1 用户取消签字
00 用户签字并确认
SigAndFigData stringArr Pdf签字中包含的数据，其中包括签字图片、签字轨迹xml、指纹图片、插入了签字图片的pdf
ret string 00 Pdf签字成功
01 Pdf签字失败

# 获取身份证信息

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 07
ReadIDCardTime string 身份证读取时间

# 输出参数

参数名称 类型 数据约束 描述
action string 07
idmsg string 身份证信息
idImageFront string 身份证正面图片base64数据
idImageFrontPath string 身份证正面图片保存路径
idImageBack string 身份证背面图片base64数据
idImageBackPath string 身份证背面图片路径
IdPicBase64 string 身份证头像照片base64
IdPicBase64 string 身份证头像照片路径
ret string 00 身份证读取成功
01 身份证读取失败

# 获取签字图片

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述 必选
action string 08 是
isRercVide string 是否录制视频，0或1，1表示录制视频，0表示不录制视频 否
VideParm string 视频录制参数，cameranum表示摄像头编号，time表示录制时间限制，示例：”{"cameranum":"0","time":"30"} “ 否
isTakePhoto string 是否进行拍照，0或1，1表示进行拍照，0表示不进行拍照 否

# 输出参数

参数名称 类型 数据约束 描述
action string 08
SigXml string 用户签名轨迹记录
SigPicBase64 string 用户签名图片base64
SigPicPath string 用户签名图片路径
result string 00 用户完成签名
-1 用户取消签名
ret string 00 用户签名成功
01 用户签名失败

# 获取指纹图片

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 09
GetFingerPicTime string 设备指纹录制时长限制（秒）

# 输出参数

参数名称 类型 数据约束 描述
action string 09
FicPicBase64 string 指纹图片base64
FicPicPath string 指纹图片路径
result string 00 用户确认指纹录取
-1 用户取消指纹录取
ret string 00 指纹录制成功
01 指纹录制失败

# 打开摄像头

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 10
CamParm string 摄像头打开参数，json字符串，详细看CamParm参数列表

CamParm参数列表

参数名称 类型 数据约束 描述
width string 摄像头打开宽度
height string 摄像头打开高度
cameranum string 需要打开的摄像头的编号

# 输出参数

参数名称 类型 数据约束 描述
action string 10
ret string 00 摄像头打开成功
01 摄像头打开失败

# 关闭摄像头

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 11

# 输出参数

参数名称 类型 数据约束 描述
action string 11
ret string 00 摄像头关闭成功
01 摄像头关闭失败

# 用户拍照

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 12

# 输出参数

参数名称 类型 数据约束 描述
action string 12
PhotoBase64 string 用户拍照图片base64
PhotoPath string 用户拍照图片路径
ret string 00 用户拍照成功
01 用户拍照失败

# 用户拍照结果

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 112

# 输出参数

参数名称 类型 数据约束 描述
action string 112
PhotoBase64 string 用户拍照图片base64
ret string 00 用户拍照成功
01 用户拍照失败

# 设置视频保存路径

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 13
VideoPath string 需要设置的视频的保存路径

# 输出参数

参数名称 类型 数据约束 描述
action string 13
ret string 00 视频保存路径设置成功
01 视频保存路径设置失败

# 开始录制视频

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 14

# 输出参数

参数名称 类型 数据约束 描述
action string 14
ret string 00 开始录制视频成功
01 开始录制视频失败

# 停止录制视频

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 15

# 输出参数

参数名称 类型 数据约束 描述
action string 15
VideoPath string 录制视频保存路径
ret string 00 停止录制视频成功
01 停止录制视频失败

# 设置待机界面

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 16
PicPath string 待机界面图片路径
ChangeTime string 待机图片切换时间（秒）

# 输出参数

参数名称 类型 数据约束 描述
action string 16
ret string 00 待机图片设置成功
01 待机图片设置失败

# 获取背景图片列表和切换时间

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 29

# 输出参数

参数名称 类型 数据约束 描述
action string 29
BkImageList stringArr 背景图片字符串列表
BkChangeTime string 背景图片切换时间
ret string 00 获取背景图片列表和切换时间成功
01 获取背景图片列表和切换时间失败

# 删除广告图片

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 30
PicPath string 需要删除的图片在背景图片列表中的名称

# 输出参数

参数名称 类型 数据约束 描述
action string 30
ret string 00 广告图片删除成功
01 广告图片删除失败

# 打开评价器

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 18
TellerData stirng 评价器相关信息，详细看TellerDate参数列表
HeadPic string 头像图片路径

TellerData参数列表

参数名称 类型 数据约束 描述
name string 姓名
jobnumber string 员工编号
department string 职位
time string 操作时间
starlevel string 评价等级
evaluateorder string 评价总分
{"time":"30","name":"测试员1号","department":"测试员","jobnumber":"10001","starlevel":"5","evaluateorder":"80"}

# 输出参数

参数名称 类型 数据约束 描述
action string 18
ret string 00 评价器打开成功
01 评价器打开失败

# 获取评价器状态

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 19

# 输出参数

参数名称 类型 数据约束 描述
action string 19
result string 00 评价器正在打开
01 评价器未打开
ret string 00 评价器状态获取成功
01 评价器状态获取失败

# 获取评价器结果

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 20

# 输出参数

参数名称 类型 数据约束 描述
action string 20
Value string 评价器分数
ret string 00 评价器结果获取成功
01 评价器结果获取失败

# 展示工牌

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 21
cardData string 工牌数据，详细看cardData参数列表
WorkCardPic string 工牌头像图片

cardData参数列表

参数名称 类型 数据约束 描述
name string 姓名
number string 工牌编号
post string 职位
{"name":"测试","number":"10001","post":"测试员"}

# 输出参数

参数名称 类型 数据约束 描述
action string 21
ret string 00 工牌显示成功
01 工牌显示失败

# 关闭工牌展示

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 22

# 输出参数

参数名称 类型 数据约束 描述
action string 22
ret string 00 关闭工牌显示成功
01 关闭工牌显示失败

# 打开URL

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 23
UrlPath string url路径
OpenUrlTime url显示时间

# 输出参数

参数名称 类型 数据约束 描述
action string 23
result 00 用户点击确定
-1 用户点击取消
-2 用户操作超时
ret string 00 url打开成功
01 url打开失败

# 打开网络PDF

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 24
NetworkPdfPath string 网络PDF路径

# 输出参数

参数名称 类型 数据约束 描述
action string 24
result string 00 用户确定
-1 用户点击取消
ret string 00 网络pdf打开成功
01 网络pdf打开失败

# 人证核验

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 25

# 输出参数

参数名称 类型 数据约束 描述
action string 25
ComapreResult string 人证核验结果
ret string 00 人证核验成功
01 人证核验失败

# 活体检测

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 26

# 输出参数

参数名称 类型 数据约束 描述
action string 26
ret string 00 设备断开连接成功
01 设备断开连接失败

# 获取版本号

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 27

# 输出参数

参数名称 类型 数据约束 描述
action string 27
VersionValue string 设备版本号
ret string 00 获取版本号成功
01 获取版本号失败

# 获取设备序列号

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 28

# 输出参数

参数名称 类型 数据约束 描述
action string 28
SNValue string 设备序列号
ret string 00 获取序列号成功
01 获取序列号失败

# Web拍照

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 34
WebCamNum string 0 或 1 摄像头编号

# 输出参数

参数名称 类型 数据约束 描述
action string 34
PhotoBase64 string 拍照图片base64
PhotoPath string 拍照图片的保存路径
ret string 00 Web拍照成功
01 Web拍照失败

# 取消操作

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 35

# 输出参数

参数名称 类型 数据约束 描述
action string 35
ret string 00 取消设备操作成功
01 取消设备操作失败

# 升级设备

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 36
filepath string 设备升级文件路径

# 输出参数

参数名称 类型 数据约束 描述
action string 36
ret string 00 设备升级成功
01 设备升级失败

# 打开PDF Base64

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 37
PdfStream string Pdfbase64数据

# 输出参数

参数名称 类型 数据约束 描述
action string 37
result string 00 用户确认
-1 用户取消
ret string 00 打开pdfbase64成功
01 打开pdfbase64失败

# 打开htmlBase64

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 38
HtmlBase64 string Html文件base64数据
OpenLocalHtmlTime string 操作时间

# 输出参数

参数名称 类型 数据约束 描述
action string 38
result string 00 用户确定
-1 用户取消
ret string 00 打开htmlbase64成功
01 打开htmlbase64失败

# 打开指纹签字

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 39
SigAndFigTime string 指纹和签字操作时间

# 输出参数

参数名称 类型 数据约束 描述
action string 39
SigPicBase64 string 签字图片base64
FicPicBase64 string 指纹图片base64
SigFigPicBase64 string 签字指纹图片base64
ret string 00 设备断开连接成功
01 设备断开连接失败

# 打开二维码扫描

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 40

# 输出参数

参数名称 类型 数据约束 描述
action string 40
QrNumber string 二维码扫描结果
ret string 00 二维码扫描成功
01 二维码扫描失败

# 打开屏幕和摄像头实时画面

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 44

# 输出参数

参数名称 类型 数据约束 描述
action string 44
ret string 00 屏幕和摄像头实时画面打开成功
01 屏幕和摄像头实时画面打开失败

# 关闭屏幕和摄像头实时画面

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 45

# 输出参数

参数名称 类型 数据约束 描述
action string 45
ret string 00 屏幕和摄像头实时画面关闭成功
01 屏幕和摄像头实时画面关闭失败

# 摄像头扫描二维码

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 46

# 输出参数

参数名称 类型 数据约束 描述
action string 46
QrNumber string 二维码数据
ret string 00 二维码扫描成功
01 二维码扫描失败

# 预览PDF并签字（签字和指纹分开）

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 47
PDFPath2 string PDF路径

# 输出参数

参数名称 类型 数据约束 描述
action string 46
PdfBase64 string PDFbase64数据
SigAndFigData JsonArr 签字图片和指纹数据
result string 00 用户操作结果
-1 取消PDF签字
ret string 00 PDF签字成功
01 PDF签字失败

# 指纹特征比对

# 输入参数

输入参数需要经过Base64加密后发送给服务器
参数名称 类型 数据约束 描述
action string 201
data1 string 第一个指纹特征
data2 string 第二个指纹特征

# 输出参数

参数名称 类型 数据约束 描述
action string 201
FigCompareRet string 0 两指纹特征是一个手指
1 两指纹特征不是一个手指
ret string 00 指纹特征比对成功
01 指纹特征比对失败
上次更新: 2023/03/11, 09:20:51
YF1013 CS SDK文档
CS SDK接口文档

← CS SDK接口文档→

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

×