API调用协议说明:
1.概述
易联云云打印开放平台通讯协议是一个无状态的、轻量级的基于HTTP的 RPC 通讯协议。
2.设计原则
本协议只定义数据交互的格式与方式,不关注数据的传输方式,不关注认证方式,不关注接口版本控制。
3.RPC 调用
开放平台的 RPC 调用主要用于客户端应用主动获取开放平台服务器端数据信息,是通过客户端应用向开放平台的API服务器发送HTTP POST请求对象,而服务器返回响应对象实现的。
**`Content-Type:application/x-www-form-urlencoded`**;
如无特殊说明,接口的所有参数值均为UTF-8编码
3.1.1 公共参数说明:
|名 称|类 型|描 述|
|----|----|----|
|client_id|string|开发者的应用ID,在[开放平台](https://dev.10ss.net)创建应用时获得|
|access_token|string|访问令牌|
|sign|string|签名 详见API文档列表-[接口签名](apiprotocol.md)|
|timestamp|int|当前服务器时间戳(10位)|
|id|string|UUID4 详见API文档列表-[UUID4](apiprotocol.md)|
3.1.2 接口签名:
将client_id+timestamp+client_secret(三个参数只需要值),再做md5,得出字符串转成小写即为sign。client_secret为应用密钥,在[开放平台](https://dev.10ss.net)创建应用后获得 。
为了防止API调用过程中被黑客恶意篡改,调用任何一个API都需要携带签名参数,API服务端会根据请求参数,对签名进行验证,签名不合法的请求将会被拒绝。
3.1.3 UUID4:
UUID4,用来唯一标记此次调用,响应对象中会包含相同的id。UUID以36字节的字符串表示,
示例如下:
3F2504E0-4F89-11D3-9A0C-0305E82C3301
3.1.4 关于境外HOST说明:需要把国内的`https://open-api.10ss.net`,替换成`https://open-api-os.10ss.net`,但是接口方法名不变!
示例如下:
国内:`https://open-api.10ss.net/oauth/oauth`
境外:`https://open-api-os.10ss.net/oauth/oauth`
- 平台简介
- 概念和术语
- 新手指南
- 开发文档
- 接入API服务指南
- API调用协议说明
- 开放应用服务模式
- 自有应用服务模式
- 扫描二维码授权模式
- 消息推送协议说明
- API文档列表
- 文本打印接口
- 图形打印接口
- 面单打印接口
- 设置内置语音接口
- 删除内置语音接口
- 删除终端授权
- 添加应用菜单
- 关机重启接口
- 声音调节接口
- 获取机型打印宽度接口
- 获取机型软硬件版本接口
- 取消所有未打印订单接口
- 取消单条未打印订单接口
- 设置logo接口
- 取消logo接口
- 打印方式接口
- 接单拒单设置接口
- 设置推送url接口
- 获取订单状态接口
- 获取订单列表接口
- 获取终端状态接口
- 推送接口
- 签名规则
- 打印完成推送
- 接单拒单推送
- 按键请求推送
- 应用菜单推送
- 打印机实时状态推送
- 打印机指令
- K7-GHC/K7-WHC排版指令
- K4-GH(新固件)/K4-WH(新固件)排版指令
- K6-WH(新固件)排版指令
- M1-G(新固件)排版指令
- W1(新固件)排版指令
- K5(新固件)排版指令
- K2S、K3S、M1排版指令
- K7、K6、K5、K4排版指令
- X1排版指令
- W1排版指令
- Ai语音播报指令
- 指令详解
- 二维码打印
- 条码打印
- 打印多联
- 字体加大
- 字体加粗
- 字体加高
- 字体加宽
- 换行
- 居中对齐
- 左右对齐
- 右对齐
- 一行三格或四格对齐排版
- 制表符
- 自定义来单提醒
- 自定义来单声音控制
- 订单确认
- SDK使用说明
- 注意事项
- 全局返回码
- 获取终端号和特殊密钥