配方管理
配方接口读写当前账号可见的配置。网页会按用户账号和机台账号过滤项目;脚本也应遵循同一原则,只修改服务返回的项目。
获取配方
http
POST /forward/get请求体
json
{
"token": "<TOKEN>",
"clientId": "<MACHINE_ID>",
"clientPwd": "<MACHINE_SECRET>"
}clientId 和 clientPwd 仅在账号有权限读取指定机台配置时填写;普通用户请求可以只传 token。
响应
json
{
"success": true,
"msg": "success",
"forwardData": {
"rule_name": {
"enable": true,
"value": "example"
}
}
}| 字段 | 类型 | 说明 |
|---|---|---|
forwardData | object | 配置名到配置对象的映射 |
forwardData.<name>.enable | boolean | 是否启用 |
forwardData.<name>.value | string | 配置值,可能为空字符串 |
添加或更新配方
http
POST /forward/add请求体
json
{
"token": "<TOKEN>",
"rule": "<VISIBLE_RULE_NAME>",
"enable": true,
"value": "<VALUE>",
"clientId": "<MACHINE_ID>",
"clientPwd": "<MACHINE_SECRET>"
}| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
token | string | 是 | 当前 Token |
rule | string | 是 | forward/get 返回且当前账号可见的配置名 |
enable | boolean | 是 | 是否启用 |
value | string | 是 | 配置值;无值时传空字符串 |
clientId | string | 否 | 机台配置的目标标识 |
clientPwd | string | 否 | 机台配置凭据 |
响应
json
{
"success": true,
"msg": "success"
}清理当前配方
http
POST /forward/del请求体
json
{
"token": "<TOKEN>",
"clientId": "<MACHINE_ID>",
"clientPwd": "<MACHINE_SECRET>"
}该操作可能清理当前账号或目标机台的配方集合,属于不可逆配置操作。调用前请先保存 forward/get 的完整响应,并确认服务返回的提示。
开发建议
- 首次运行先调用
forward/get,不要预置未知配置名; - 修改前保存原值,失败时恢复原值;
- 用户配置和机台配置分开保存;
- 不要把机台凭据发送到浏览器之外的第三方服务;
- 修改后让机台重新加载配置,并在网页端确认结果。
