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使用說明
- 注意事項
- 全局返回碼
- 獲取終端號和特殊密鑰