📝 Docker API 服务文档

README.md

@@ -2,16 +2,18 @@
 
 中国电信 话费、通话、流量 套餐用量监控。
 
-本脚本是部署在服务器（或x86软路由等设备）使用接口模拟登录获取Token，定时获取电信手机话费、通话、流量使用情况，推送到各种通知渠道提醒。
+本项目是部署在服务器（或x86软路由等设备）使用接口模拟登录，定时获取电信手机话费、通话、流量使用情况，推送到各种通知渠道提醒。
 
 ## 特性
 
-- [x] 兼容青龙
-- [x] 本地保存Token，有效期内不重复登录
+- [x] 支持青龙
 - [x] 支持通过 json push_config 字段独立配置通知渠道
-- [ ] Docker 独立部署，开放查询 API
+- [x] 本地保存登录 token ，有效期内不重复登录
+- [x] Docker 独立部署 API 查询服务
 
-## 青龙部署
+## 部署
+
+### 青龙监控
 
 拉库命令：
 
@@ -23,10 +25,55 @@ ql repo https://github.com/Cp0204/ChinaTelecomMonitor.git "telecom_monitor" "" "
 | -------------- | --------------------- | ------------------------------ |
 | `TELECOM_USER` | `18912345678password` | 手机号密码直接拼接，会自动截取 |
 
+### Docker API 服务
+
+注意：Docker 部署的是 API 服务，没有监控提醒功能，主要是用于第三方（如 HomeAssistant 等）获取信息，数据原样返回。
+
+```shell
+docker run -d \
+  --name china-telecom-monitor \
+  -p 10000:10000 \
+  -v ./china-telecom-monitor/config:/app/config \
+  -v /etc/localtime:/etc/localtime \
+  -e WHITELIST_NUM= \
+  --network bridge \
+  --restart unless-stopped \
+  cp0204/chinatelecommonitor:main
+```
+
+| 环境变量        | 示例                      | 备注         |
+| --------------- | ------------------------- | ------------ |
+| `WHITELIST_NUM` | `18912345678,13312345678` | 手机号白名单 |
+
+#### 接口URL
+
+- `http://127.0.0.1:10000/login`
+
+  登录，返回用户信息，token长期有效，用以下次请求数据
+
+- `http://127.0.0.1:10000/qryImportantData`
+
+  返回主要信息，总用量 话费、通话、流量 等
+
+- `http://127.0.0.1:10000/userFluxPackage`
+
+  返回流量包明细
+
+接口均支持 POST 和 GET 方法，POST 时 Body 须为 json 数据，请求参数：
+
+```json
+{
+  "phonenum": "18912345678",
+  "password": "123456"
+}
+```
+
+> [!NOTE]
+> 登录成功后，会在 config/login_info.json 文件**记录账号敏感信息**。程序请求数据将先尝试用记录的 token 获取，避免重复登录。
 
 ## 感谢
 
-本项目大量参考前人的代码，在此表示感谢！
+本项目大量参考其他项目的代码，在此表示感谢！
 
 - [ChinaTelecomMonitor](https://github.com/LambdaExpression/ChinaTelecomMonitor) : go 语言的实现
 - [boxjs](https://github.com/gsons/boxjs) : 感谢开源提供的电信接口