能力接入

获取打印机状态

获取当前设备连接的打印机的型号、状态、是否支持双面、是否支持彩色。

接口地址

https://open.aimiaoyin.com/api/v1/device/getPrinterStatus

请求方法

GET

请求参数

参数名 类型 必需 说明
app_id string Y 开放平台申请的appId
sign string Y app签名 (查看接口鉴权)
nonce_str string Y 随机字符串 (查看接口鉴权)
time_stamp string Y 10位时间戳 (查看接口鉴权)
device_sn string Y 设备SN码

响应参数

参数名 类型 说明
printer_model string 打印机型号
printer_status int 打印机状态 (查看状态码定义)
support_paper string 打印机支持的纸张,以半角逗号,隔开 (查看纸张类型定义)
support_duplex int 打印机是否支持双面,0=不支持,1=支持
support_color int 打印机是否支持双面,0=不支持,1=支持
update_time string 更新时间

请求示例

app_id=XXXXXXXX&sign=XXXXXXXX&device_sn=XXXXXXXX

响应示例

{
    "code": 200,
    "message": "打印机状态",
    "data": {
        "printer_model": "XXX Printer",
        "printer_status": 0,
        "support_paper": "8,9",
        "support_duplex": 1,
        "support_color": 0,
        "update_time": "1567590473"
    }
}

添加打印任务

给设备添加打印任务,设备联网获取到任务后将自动读取并执行任务。

接口地址

https://open.aimiaoyin.com/api/v1/device/addPrintJob

请求方法

POST

请求参数

参数名 类型 必需 说明
app_id string Y 开放平台申请的appId
sign string Y app签名 (查看接口鉴权)
nonce_str string Y 随机字符串 (查看接口鉴权)
time_stamp string Y 10位时间戳 (查看接口鉴权)
device_sn string Y 设备SN码
out_job_no string Y 由开发者定义的任务识别号
file_url string Y PDF文件的地址,需要urlencode
copies int Y 打印份数
paper_size int Y (查看纸张类型定义)
color int Y 是否彩色打印,0=黑白打印,1=彩色打印
duplex int Y 是否双面打印,0=单面打印,1=长边双面打印
callback_url string Y 打印完成回调地址,需要urlencode (查看接收回调方法)

响应参数

参数名 类型 说明
device_sn string 设备SN码
out_job_no string 由开发者定义的任务识别号
create_time string 创建时间

请求示例

app_id=XXXXXXXX&sign=XXXXXXXX&device_sn=XXXXXXXX&out_job_id=100001&file_url=http%3a%2f%2ffile%3f%26type%3dpdf&paper_size=9&color=1&duplex=0&callback_url=http%3a%2f%2fcallback%3f%26a%3dp

响应示例

{
    "code": 200,
    "message": "添加任务成功",
    "data": {
        "device_sn": "XXXXXXXX",
        "out_job_no": "100001",
        "create_time": "1567590473"
    }
}

获取打印完成事件回调

设备打印完成后,喵印开放平台服务器将会给开发者添加打印任务时填入的callback_url发送POST请求。

注意事项

  • 通过在添加打印任务时填入的out_job_no字段来识别不同的任务。
  • 喵印开放平台服务器只会发送一次请求,在10秒内收不到响应则会断开请求。

回调请求方法

POST

回调数据类型

Content-Type: application/json

回调示例

{
    "out_job_no": "100001",
    "device_sn": "XXXXXXXX",
    "print_result": "1",
    "end_time": "1567590473"
}

回调参数

参数名 类型 说明
out_job_no string 由开发者定义的任务识别号
device_sn string 设备SN码
print_result int 打印完成状态,1=打印完成,0=打印失败
end_time string 完成时间

results matching ""

    No results matching ""