# K8关键词设置
### 一、阅读前提
1. 调用此接口先详细阅读[K8授权说明文档](https://www.kancloud.cn/ly6886/k8-push/3191599),并完成授权认证与[推送开关设置](推送开关设置.md),才能调用此接口。
2. 设备须在线,才能触发指令控制。
3. 关于一二级黑白名单作用说明:当一个订单进入我们的系统时,它首先会经过一级黑白名单系统的检查、识别服务。如果一级系统无法明确识别订单,订单将继续通过二级黑白名单系统的筛选,以提高准确性。
4. 关于白名单设置说明,设置一二级白名单的关键词个数必须一样。示例说明:白名单单个关键词占位示例`[""]`,两个关键词占位示例`["",""]`,依此类推。
### 二、设置接口
#### 接口信息
|协议|方式|地址
|-|-|-|
|https|POST|/printer/setkeywords
#### 请求参数
|名称|类型|必填|描述
|-|-|-|-|-|
|client_id|string|是|应用id
|sign|string|是|签名
|timestamp|int|是|时间戳(秒)
|id|string|是|请求唯一标识码
|access_token|string|是|调用凭证
|machine_code|string|是|终端号
|keys|string|是|`order_payment`=需支付关键词;`order_non_payment`=指定关闭支付关键词;`order_id`=重打关键词;`order_refund`=退款关键词;`all`=所有关键词;
|type|string|是|`white_list`=白名单;`two_white_list`=二级白名单;`black_list`=黑名单;`two_black_list`=二级黑名单;`all`=所有黑白名单
|content|json数组|是|关键词数据,一个数组中最大能设置`5个关键词`,单个关键词长度不能超过`10个中文字符`或者`20个英文字符`
#### content 字段示例
##### 正确示例:
一级白名单
```json
["小计","总金额","支付"]
```
二级白名单
```json
["","",""]
```
当keys和type的值等于`all`时示例
```json
{"order_non_payment":{"white_table":["关键字1","关键字2","关键字3"],"black_table":["关键字1","关键字2","关键字3"],"white_table2":["关键字1","关键字2","关键字3"],"black_table2":["关键字1","关键字2","关键字3"]},"order_id":{"white_table":["关键字1","关键字2","关键字3"],"black_table":["关键字1","关键字2","关键字3"],"white_table2":["关键字1","关键字2","关键字3"],"black_table2":["关键字1","关键字2","关键字3"]},"order_payment":{"white_table":["关键字1","关键字2","关键字3"],"black_table":["关键字1","关键字2","关键字3"],"white_table2":["关键字1","关键字2","关键字3"],"black_table2":["关键字1","关键字2","关键字3"]},"order_refund":{"white_table":["关键字1","关键字2","关键字3"],"black_table":["关键字1","关键字2","关键字3"],"white_table2":["关键字1","关键字2","关键字3"],"black_table2":["关键字1","关键字2","关键字3"]}}
```
##### 错误示例:
一级白名单
```json
["小计","总金额"]
```
二级白名单
```json
["","",""]
```
#### 响应参数
|名称|类型|描述
|-|-|-|-|
|error|int|成功0,其他为异常
|error_description|string|提示信息
|timestamp|int|时间戳(秒)
|body|json|数据
- 使用前准备【必看】
- 开发者服务指引【必看】
- 接口更新动态
- 2024年5月
- 2024年1月
- 2023年11月
- 2023年10月
- 2023年9月
- 2023年6月
- 开发文档【必看】
- 调用协议【必看】
- 授权文档【必接】
- 自有型应用
- 开放型应用(OAuth2.0授权码模式)
- 开放型应用(扫码授权模式)
- SDK使用说明
- API文档【按需对接】
- 设备文档
- 设备绑定
- 设备解绑或取消授权
- 状态获取
- 离线或重启控制
- 打印控制
- logo控制
- 音效音量控制
- 内置语音控制
- 打印宽度获取
- 型号版本获取
- 接单拒单控制
- 打印文档
- 文本打印
- 图片打印
- 面单文档
- 面单生成并打印
- 面单取消
- 打印队列文档
- 订单状态获取(单订单)
- 订单列表获取
- 订单取消打印(单订单)
- 订单取消打印(全量)
- 订单重打(单订单)
- 应用设置文档
- 推送地址设置
- K8支付设置文档
- 推送开关设置
- 关键词设置
- 高级设置
- 打印消息推送
- 打印消息推送说明
- 打印完成推送
- 终端状态推送
- 接单拒单推送
- K8扫码信息推送
- 产品介绍
- 授权说明
- 消息推送
- http/https推送方式
- 签名验证规则
- 解密规则
- 指令说明
- 验签解密示例
- 打印指令文档
- 指令文档说明
- 指令集
- 常见问题
- 错误码说明
- FAQ