BS SDK接口文档
YF1012/1013 SDK接口文档 B/S版
| 产品名称 | YF1012/1013 |
|---|---|
| 当前版本号 | 1.10.0 |
# 服务地址：
http://127.0.0.1(域名):28810
通信协议：
API 的所有接口均通过 HTTP进行通信
请求方法：
请求方式：GET
字符编码：
均使用UTF-8编码
# 公共参数：
公共参数是用于标识用户和接口权目的的参数
| 参数名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| action | string | 是 | 具体操作的指令接口名称 |
| ret | string | 是 | 响应报文对请求功能的返回值描述 |
用户请求链接的形式举例：(请求参数需要经过Base64加密)
{"action":"50" }
响应报文描述实例：
{"ret":"00"}
跨域请求参数：
处理浏览器跨域请求问题而设置的报文头参数。
| 参数 | 参数设置 | 必选 | 描述 |
|---|---|---|---|
| Access-Control-Allow-Origin | http:\\127.0.0.1:20240 | 是 | |
| Access-Control-Allow-Headers | origin,x-requested-with,token,content-type | 是 | |
| Access-Control-Max-Age | 1800 | 是 | |
| Access-Control-Allow-Methods | True | 是 |
# 服务接口说明：
# 获取设备状态
接口描述
请求路径：服务地址
接口说明：
接口返回：
输入参数
输入参数需要经过Base64加密后发送给服务器。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 00 |
输出参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见“公共参数”。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 00 | |
| return | string | 00 | 设备连接成功 |
| 01 | 连接成功，但分辨率设置失败 | ||
| 03 | 依赖项缺失 | ||
| 04 | 连接失败 |
# 单签字功能
接口描述
请求路径：服务地址
接口说明：
接口返回：
输入参数
输入参数需要经过Base64加密后发送给服务器。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 01 | |
| UserName | string | 签字人名字 |
输出参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见“公共参数”。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 01 | |
| retustring | string | return为00时 | 图片base64数据 |
| return | string | 00 | 成功 |
| 01 | 取消 | ||
| 02 | 图片获取失败 | ||
| 03 | 依赖项缺失 |
注意：单签字不能同时和PDF 存在
# 单指纹功能
接口描述
请求路径：服务地址
接口说明：
接口返回：
输入参数 输入参数需要经过Base64加密后发送给服务器。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 02 | |
| FingColor | string | 1 红色 | |
| 0 黑色 | 指纹颜色 |
输出参数 以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见“公共参数”。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 02 | |
| retustring | string | return为00时 | 图片base64数据 |
| return | string | 00 | 成功 |
| 01 | 取消 | ||
| 02 | 图片获取失败 | ||
| 03 | 依赖项缺失 |
注意：单指纹不能同时和PDF 存在 注意：单指纹不能同时和PDF 存在
# 以下为PDF功能
# 初始化PDF文件
接口描述
请求路径：服务地址
接口说明：
接口返回：
输入参数
输入参数需要经过Base64加密后发送给服务器。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 30 | |
| htmlString | string | 空 | |
| viewAllSign | bool | 空 | |
| PdfBase64Data | string | PDFbase64加密数据 | PDFbase64加密数据 |
输出参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见“公共参数”。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 30 | |
| return | string | 00 | 成功 |
| 01 | 文件保存失败 |
# 打开PDF
接口描述
请求路径：服务地址
接口说明：
接口返回：
输入参数
输入参数需要经过Base64加密后发送给服务器。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 31 |
输出参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见“公共参数”。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 31 | |
| return | string | 00 | 成功 |
| 11 | 显示设置错误 | ||
| 10 | 已有PDF展示 | ||
| 12 | 其他错误 |
# 获取PDF状态
接口描述
请求路径：服务地址
接口说明：
接口返回：
输入参数
输入参数需要经过Base64加密后发送给服务器。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 34 |
输出参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见“公共参数”。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 34 | |
| return | string | 0 | 正在操作PDF |
| 1 | 取消 | ||
| 2 | 确认 | ||
| 3 | 上层关闭 |
# 关闭PDF展示
接口描述
请求路径：服务地址
接口说明：
接口返回：
输入参数
输入参数需要经过Base64加密后发送给服务器。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 36 |
输出参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见“公共参数”。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 36 | |
| return | string | -1 | 当前没有PDF展示 |
| 00 | 成功关闭 |
# URL模式转PDF并展示
接口描述
请求路径：服务地址
接口说明：
接口返回：
输入参数
输入参数需要经过Base64加密后发送给服务器。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 30 | |
| UrlValue | string | 网页URL，url编码格式 | 需要展示的URL链接，该网址会转成PDF展示并合成 |
输出参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见“公共参数”。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 30 | |
| return | string | 00 | 成功 |
| 01 | 文件保存失败 |
# URL base64数据格式转PDF并展示
接口描述
请求路径：服务地址
接口说明：
接口返回：
输入参数
输入参数需要经过Base64加密后发送给服务器。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 30 | |
| UrlBase64Data | string | 网页URL | 该网址会转成PDF展示并合成 |
输出参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见“公共参数”。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 30 | |
| return | string | 00 | 成功 |
| 01 | 文件保存失败 |
# 获取PDF Base64
接口描述
请求路径：服务地址
接口说明：
接口返回：
输入参数
输入参数需要经过Base64加密后发送给服务器。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 35 |
输出参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见“公共参数”。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 35 | |
| PdfDataGet | string | Pdfbase64 | |
| return | string | 00 | 成功 |
| 01 | 文件保存失败 |
# 获取图片base64
接口描述
请求路径：服务地址
接口说明：
接口返回：
输入参数
输入参数需要经过Base64加密后发送给服务器。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 37 |
输出参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见“公共参数”。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 37 | |
| sigPicData | string | 签字图片base64 | |
| figPicData | string | 指纹图片base64 | |
| sigfigPicData | string | 指纹签字合成图片base64 | |
| paramJson | string | 用户选择的paramJson | |
| return | string | 00 | 成功 |
| 01 | 文件保存失败 |
# 获取图片base64
接口描述
请求路径：服务地址
接口说明：
接口返回：
输入参数
输入参数需要经过Base64加密后发送给服务器。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | ff | |
| paramJson | string | 用户提交的paramJson |
输出参数
该接口无输出参数
# Pdf预览
接口描述
请求路径：服务地址
接口说明：
接口返回：
输入参数
输入参数需要经过Base64加密后发送给服务器。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 60 | |
| viewAllConfirm | bool | 控制是否预览完成才能点确定 |
输出参数
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 60 | |
| return | string | 19 | 用户pdf预览完毕 |
| 20 | 用户pdf未预览完毕关闭 | ||
| 21 | 操作人员关闭pdf |
# 打开多签字
接口描述
请求路径：服务地址
接口说明：
接口返回：
输入参数
输入参数需要经过Base64加密后发送给服务器。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 61 | |
| LineLen | int | 每行签字的长度 |
输出参数
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 61 | |
| SignImgBase64 | string Array | 签字图片base64数组 | |
| return | string | 00 | 多签字成功 |
| 01 | 多签字失败 | ||
| 02 | 多签字窗口未关闭 |
# 关闭多签字
接口描述 请求路径：服务地址
接口说明：
接口返回：
输入参数
输入参数需要经过Base64加密后发送给服务器。
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 62 |
输出参数
| 参数名称 | 类型 | 数据约束 | 描述 |
|---|---|---|---|
| action | string | 62 | |
| return | string | 00 | 关闭多签字成功 |
| 01 | 关闭多签字失败 |