打印接口
本节介绍易联云API最重要的功能,发送数据到易联云API并通过易联云打印机输出打印,以及对应的返回状态码。
API接口地址(发送打印数据的端点)
端口:8888
API调用方法
发送打印数据到易联云API请求以及参数应该用POST方法发送。易联云API将根据收到的信息验证请求的有效性反馈对应的状态码。
必填参数和需要提交的参数
发送打印数据到易联云请求必须包含以下参数 (系统参数和应用参数)
系统级输入参数
名称 | 类型 | 是否提交 | 是否必填 | 描述 |
---|---|---|---|---|
partner | int | 是 | 是 | 用户id(管理中心系统集成里默取) |
sign | String | 是 | 是 | API输入签名结果(生成的参数) |
machine_code | String | 是 | 是 | 打印机终端号 |
time | int | 是 | 是 | 当前时间戳(服务器用于验证超时) |
mkey | String | 否 | 是 | 打印机终端密钥 |
apikey | String | 否 | 是 | apikey(管理中心系统集成里默取) |
应用级输入参数
名称 | 类型 | 是否提交 | 是否必填 | 描述 |
---|---|---|---|---|
content | String | 是 | 是 | 需要传输打印的内容数据 |
举例:
$partner = 6 //用户ID
$apikey=d17d7d6cdaaa77a6dba928b6553c665325a033d5 //API密钥
$machine_code=613 //打印机终端号
$mkey=123456 //打印机密钥
$time=1427647569 //当前时间戳
$content=测试打印 //打印内容
$sign= F5459E23A8EA943F6D76961FEF796963 //生成的签名加密
签名加密算法如下:
sign=apikey+(content+machine_code+partner+time)+mkey 串在一起后进行MD5加密然后再转换成大写,括号里面的参数是需要名和值的,apikey和mkey只需要值
从以上举例中得到的加密参数:
d17d7d6cdaaa77a6dba928b6553c665325a033d5machine_code613partner6time1427647569123456
这是未加密前串在一起的排列,然后把这串字符进行MD5加密得到的结果就是sign的值
需要传递给API的参数是:
partner、machine_code、content、time、sign //这5个参数是需要提交给API端点的
举例提交内容如下:
partner=6&machine_code=613&time=1427647569&sign=1F19C52B0EE3FE0F36FEF7487795F9F7&content=测试打印
返回JSON数据的状态码 {"state":"1","id":"1234"} 数据提交成功,1234代表单号,打印完成上报时用、详情请查看打印完成自动上报接口文档
{"state":"2"} 提交时间超时。验证你所提交的时间戳超过3分钟后拒绝接受
{"state":"3"} 参数有误
{"state":"4"} sign加密验证失败