COMWAY云打印API参考手册
本章节介绍COMWAY云打印提供的所有应用
程序接口、方法以及对应的参数。中文传输编码为UTF-8。
具体而言,COMWAY云打印API支持您的网站/业务
系统用以下方式调用COMWAY云打印云打印机,
1. 发送数据到COMWAY云打印输出。
2. 查询打印机
工作状态(例如:正常、纸少、缺纸等)
1. PHP API 接口
此API接口适合于PHP架构的网站使用,需要用户确认的是该网站是否允许php页面创建临时的log文件。是否可以创建文件可以通过api接口中的testdir.php测试。结果显示为是否可以创建目录以及是否可以创建文件,若不允许创建目录,请先创建dtulog目录,并将权限改为777。
1.1 接口包含文件
PHP API接口主要包含以下几个文件: dsconfig.class.php: API库的
常用参数设置,具体参数以及解释可以参考代码说明。 dsprint.class.php: API库的打印主要类DsPrintSend,通过该类实现打印。
dsreceive.class.php: API库的接收函数,异步通讯接收打印机的响应。 HttpClient.class.php: API库的支持 HTTP 协议的客户端编程工具包。 测试参考代码文件:
testdir.php: 用于测试PHP网站空间是否支持创建目录以及创建文件,具体测试代码可以参考代码。
apitest.php: 打印测试示例代码。用于直接调用API库进行打印测试,某些参数依赖于dsconfig.class.php里面的设定。
index.php: Comway云打印中心测试网页代码,参考范例。
printapi.php: Comway云打印中心测试网页显示打印结果代码,参考范例。
1.2 接口调用流程
1. 搭建PHP API环境
a. 按照自己的环境需求,必须更改dsconfig.class.php文件里面的参数定义。主要
涉及以下几个参数:
define('APP_ID','your_appid');//每个申请使用Comway云打印的用户即可分配一个唯一的appid号,此处填写您的appid
define('DSUSERID','your_userid');//无线串口登录用户名,此处填写您
1 / 8
2.
的userid
define('PASSWORD','your_password');//无线串口用户登录密码,此处填写您的密码
//查询打印机状态的指令
define('QUERY_PRINTER',"\x1B\x76");//各个打印机可能查询纸状态指令不同,默认为:0x1B,0x76,佳博打印机的查询指令
//内网中测试可以打印,但是可能会提取不到打印机的结果,这是因为COMWAY云打印服务采取异步通讯,url callback的方式提交结果,在公网中访问不到您的内网dsreceive.class.php网页。
//当网页发布到公网空间后,若公网可以访问到您网站空间的
dsreceive.class.php网页,即可提取到结果。
$receivephp='teamfusion.gnway.net:5858/dsreceive.class.php';//填写您的空间访问地址,这个地址只是一个范例
//临时文件目录,云打印需要写临时文件,可根据用户情况更换路径,默认在下级dtulog目录下。
//可以根据用户情况更改路径,路径为相对路径,用户也可以更改为绝对路径,例如: /home/vhosts/comway.freetzi/dtulog/;若PHP空间不允许
页面执行脚本创建目录,可以用户手工创建目录dtulog。
$dtupath='dtulog/';//建议更改为绝对路径
$dtutmplines=30;//保存dtu log的记录数。默认不需要修改。
$errorlog=false;//是否输出log,默认保存错误log的文件为$dtupath目录下的errlog.txt。初期调试时可设为true,生产上线一段时间后,可设为false。
b. 确认页面及打印机支持的中文编码。默认是页面传输UTF-8编码转换成打印机支持的GBK编码。
$text=mb_convert_encoding($text,"GBK","UTF-8"); 将对应的编码转换为GBK编码,因多数打印机支持的中文都是该编码。 注:若有特殊,请对应更改页面传输过来的中文编码,以及打印机支持的中文编码。如果在传入字符串中有打印机的指令,则可能造成转码失败。在这种情况下,可以先将打印的字符