# 调用协议
### 一、概述
1. 易联云云打印开放平台通讯协议是一个无状态的、轻量级的基于HTTP的 RPC 通讯协议。
### 二、安全说明
1. 出于用户体验考虑,同时为了平衡兼容和安全风险,接口网关侧支持https,入驻用户请使用https 协议。
### 三、设计原则
1. 本协议只定义数据交互的格式与方式,不关注数据的传输方式,不关注认证方式,不关注接口版本控制。
### 四、RPC 调用
1. 开放平台的 RPC 调用主要用于客户端应用主动获取开放平台服务器端数据信息,是通过客户端应用向开放平台的API服务器发送HTTP POST或GET请求对象,而服务器返回响应对象实现的。
### 五、Content-type请求头
1. 应用发起API调用请求时需要指定Content-Type请求头,具体规则如下:Content-Type:application/x-www-form-urlencoded 如无特殊说明,接口的所有参数值均为UTF-8编码。
### 六、接口域名说明
#### 域名
1. 国内域名:https://open-api.10ss.net/v2
2. 境外域名(无需修改DNS):https://open-api-os.10ss.net/v2
3. 如果您不想修改DNS,可以使用以下国内域名:https://cloud-open-api.10ss.net/v2
3. 请根据服务器所在区域合理的请求相应域名。
#### 修改本地DNS解析
* linux下:
1. 打开终端。
2. 输入以下命令以使用root权限打开hosts文件:`sudo vim /etc/hosts`
3. 在文件的末尾或你想要添加的位置,添加新的条目。
115.28.157.32 open-api.10ss.net
* windows下:
1. 打开资源管理器,并导航到以下路径:C:\Windows\System32\drivers\etc。
2. 找到一个名为"hosts"的文件。
3. 右键点击该文件,选择"以管理员身份运行",以便获取修改权限。
4. 选择一个文本编辑器(如Notepad++、Sublime Text或记事本)打开hosts文件。
5. 在文件的末尾添加新的条目,每行表示一个条目。
115.28.157.32 open-api.10ss.net
### 七、其它说明
1. sign(接口签名)
1. 入签参数client_id、client_secret、timestamp。
2. 按照client_id、timestamp、client_secret排列方式,将相应参数的值进行拼接。
3. 示例:假设client_id的值为A、client_secret的值为B、timestamp的值为C,进行拼接后的待签字符串为ACB。
4. 将上一步得到的字符串进行MD5编码,得到sign参数的值。
2. id(请求唯一标识码)
1. 采用UUIDv4协议,使用128位数字表示,通常以连字符分隔为五个部分,形式为8-4-4-4-12的组合。每个部分都由十六进制表示。
2. UUIDv4类似于以下格式。示例:550e8400-e29b-41d4-a716-446655440000
- 使用前准备【必看】
- 开发者服务指引【必看】
- 接口更新动态
- 2024年5月
- 2024年1月
- 2023年11月
- 2023年10月
- 2023年9月
- 2023年6月
- 开发文档【必看】
- 调用协议【必看】
- 授权文档【必接】
- 自有型应用
- 开放型应用(OAuth2.0授权码模式)
- 开放型应用(扫码授权模式)
- SDK使用说明
- API文档【按需对接】
- 设备文档
- 设备绑定
- 设备解绑或取消授权
- 状态获取
- 离线或重启控制
- 打印控制
- logo控制
- 音效音量控制
- 内置语音控制
- 打印宽度获取
- 型号版本获取
- 接单拒单控制
- 打印文档
- 文本打印
- 图片打印
- 面单文档
- 面单生成并打印
- 面单取消
- 打印队列文档
- 订单状态获取(单订单)
- 订单列表获取
- 订单取消打印(单订单)
- 订单取消打印(全量)
- 订单重打(单订单)
- 应用设置文档
- 推送地址设置
- K8支付设置文档
- 推送开关设置
- 关键词设置
- 高级设置
- 打印消息推送
- 打印消息推送说明
- 打印完成推送
- 终端状态推送
- 接单拒单推送
- K8扫码信息推送
- 扫码相关功能流程图
- 产品介绍
- 授权说明
- 消息推送
- http/https推送方式
- 签名验证规则
- 解密规则
- 指令说明
- 验签解密示例
- 打印指令文档
- 指令文档说明
- 文本打印指令集
- 语音指令文档
- 多语言指令文档
- 扫码功能指令
- 常见问题
- 错误码说明
- FAQ