文档
YF0503 YF0504

BS SDK接口文档

# YF0504 SDK接口文档

产品名称	YF0504
产品编号	YF0504（http）
当前版本号	1.0.0

文档记录表

版本号	修改时间	修改人	修改内容	备注
1.0.0	2023-01-22	文工	完成该文档初版编写

# 使用说明

# 服务地址

http://127.0.0.1:28815

# 通信协议

HTTP

# 请求方式

POST

# 字符编码

UTF-8

# 公共参数

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

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

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

{"action": "50"}

响应报文描述实例：

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

# 跨域请求参数

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

参数	参数设置	必选
Access-Control-Allow-Origin	http://127.0.0.1:28815 (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
AdPicBase64	string		广告图片base64

# 输出参数

参数名称	类型	数据约束	描述
action	string	01
result	int	0	广告图片发送成功
		-2	设备未连接
		-1	设备连接失败
		-3	其他错误

# 显示广告图片

# 输入参数

输入参数需要经过base64加密后发送给服务器

参数名称	类型	数据约束	描述
action	string	02

# 输出参数

参数名称	类型	数据约束	描述
action	string	02
result	int	0	广告图片显示成功
		-2	设备未连接
		-1	设备连接失败
		-3	其他错误

# 设置开机logo

# 输入参数

输入参数需要经过base64加密后发送给服务器

参数名称	类型	数据约束	描述
action	string	03
LogoPicBase64	string		Logo图片base64

# 输出参数

参数名称	类型	数据约束	描述
action	string	03
result	int	0	Logo图片发送成功
		-2	设备未连接
		-1	设备连接失败
		-3	其他错误

# 打开中文签字界面

# 输入参数

输入参数需要经过base64加密后发送给服务器

参数名称	类型	数据约束	描述
action	string	04

# 输出参数

参数名称	类型	数据约束	描述
action	string	04
SigPicBase64	string		签字图片base64数据
result	int	0	中午呢签字完成
		-2	设备未连接
		-1	用户取消签字
		-3	其他错误

# 打开英文签字界面

# 输入参数

输入参数需要经过base64加密后发送给服务器

参数名称	类型	数据约束	描述
action	string	05

# 输出参数

参数名称	类型	数据约束	描述
action	string	05
SigPicBase64	string		签字图片base64数据
result	int	0	英文签字完成
		-2	设备未连接
		-1	用户取消签字
		-3	其他错误

# 打开白屏签字

# 输入参数

输入参数需要经过base64加密后发送给服务器

参数名称	类型	数据约束	描述
action	string	06

# 输出参数

参数名称	类型	数据约束	描述
action	string	06
result	int	0	签字白板打开成功
		-2	设备未连接
		-1	签字白板打开失败
		-3	其他错误

# 签字确认

# 输入参数

输入参数需要经过base64加密后发送给服务器

参数名称	类型	数据约束	描述
action	string	07

# 输出参数

参数名称	类型	数据约束	描述
action	string	07
SigPicBase64	string		签字图片base64
result	int	0	签字确认成功
		-2	设备未连接
		-1	签字确认失败
		-3	其他错误

# 重签

# 输入参数

输入参数需要经过base64加密后发送给服务器

参数名称	类型	数据约束	描述
action	string	08

# 输出参数

参数名称	类型	数据约束	描述
action	string	08
result	int	0	重签成功
		-2	设备未连接
		-1	重签失败
		-3	其他错误

# 关闭屏幕

# 输入参数

输入参数需要经过base64加密后发送给服务器

参数名称	类型	数据约束	描述
action	string	09

# 输出参数

参数名称	类型	数据约束	描述
action	string	09
result	int	0	屏幕关闭成功
		-2	设备未连接
		-1	屏幕关闭失败
		-3	其他错误

# 开启屏幕

# 输入参数

输入参数需要经过base64加密后发送给服务器

参数名称	类型	数据约束	描述
action	string	10

# 输出参数

参数名称	类型	数据约束	描述
action	string	10
result	int	0	屏幕打开成功
		-2	设备未连接
		-1	屏幕打开失败
		-3	其他错误

# 打开中文签字UI

# 输入参数

输入参数需要经过base64加密后发送给服务器

参数名称	类型	数据约束	描述
action	string	11

# 输出参数

参数名称	类型	数据约束	描述
action	string	11
SigPicBase64	string		签字图片base64
result	int	0	中文签字UI成功
		-2	设备未连接
		-1	中文签字UI失败
		-3	其他错误

# 打开英文签字UI

# 输入参数

输入参数需要经过base64加密后发送给服务器

参数名称	类型	数据约束	描述
action	string	12

# 输出参数

参数名称	类型	数据约束	描述
action	string	12
SigPicBase64	string		签字图片base64
result	int	0	英文签字UI成功
		-2	设备未连接
		-1	英文签字UI失败
		-3	其他错误

# 取消操作

# 输入参数

输入参数需要经过base64加密后发送给服务器

参数名称	类型	数据约束	描述
action	string	13

# 输出参数

参数名称	类型	数据约束	描述
action	string	13
result	int	0	取消操作成功
		-2	设备未连接
		-1	取消操作失败
		-3	其他错误

# 录取指纹

# 输入参数

输入参数需要经过base64加密后发送给服务器

参数名称	类型	数据约束	描述
action	string	14

# 输出参数

参数名称	类型	数据约束	描述
action	string	14
FigPicBase64	string		指纹图片base64
result	int	0	指纹图片获取成功
		-2	设备未连接
		-1	指纹图片获取失败
		-3	其他错误

# 获取序列号

# 输入参数

输入参数需要经过base64加密后发送给服务器

参数名称	类型	数据约束	描述
action	string	15

# 输出参数

参数名称	类型	数据约束	描述
action	string	15
DevSerNum	string		设备序列号
result	int	0	设备序列号获取成功
		-2	设备未连接
		-1	设备序列号获取失败
		-3	其他错误

上次更新: 2023/03/11, 09:20:51

CS SDK接口文档→