92 lines
2.5 KiB
Markdown
92 lines
2.5 KiB
Markdown
# autman-plugins
|
|
|
|
Autman 插件集合仓库。
|
|
|
|
这个仓库后续统一存放 BOSS 的 Autman 插件，包括但不限于 SimAdmin API 集成插件。
|
|
|
|
## 目录规划
|
|
|
|
```text
|
|
py/ # 实机 Python 脚本插件（参考已有可用插件，优先复制这里的一层 .py 文件）
|
|
js/ # 实机 JS 插件 / 路由插件
|
|
plugins/ # 插件说明、归档和按插件名组织的源码副本
|
|
examples/ # 示例配置 / 调用示例
|
|
docs/ # 设计说明、接口说明、参考资料
|
|
```
|
|
|
|
## 已规划插件
|
|
|
|
### SimAdmin API 插件
|
|
|
|
目标能力：
|
|
|
|
- 获取 SimAdmin 运行状态
|
|
- 获取设备 / SIM / 蜂窝网络状态
|
|
- 发送短信
|
|
- 查询短信列表和短信统计
|
|
|
|
参考 SimAdmin 默认地址：
|
|
|
|
```text
|
|
http://<simadmin-host>:3000
|
|
```
|
|
|
|
常用接口：
|
|
|
|
```text
|
|
GET /api/health
|
|
GET /api/device
|
|
GET /api/sim
|
|
GET /api/network
|
|
GET /api/data
|
|
GET /api/stats
|
|
POST /api/sms/send
|
|
GET /api/sms/list
|
|
GET /api/sms/stats
|
|
```
|
|
|
|
短信发送请求体：
|
|
|
|
```json
|
|
{
|
|
"phone_number": "13800138000",
|
|
"content": "测试短信"
|
|
}
|
|
```
|
|
|
|
## 安全注意
|
|
|
|
插件侧应增加 `access_token` 或 Autman 自身权限校验，避免未授权调用短信发送等敏感操作。
|
|
|
|
## 当前状态
|
|
|
|
初始通用仓库骨架已创建。等待 BOSS 上传既有 Autman 插件后，再按实际风格补齐实现。
|
|
|
|
### 起点读书 QDReader 签到插件
|
|
|
|
- 正式源码：`plugins/qdreader/qdreader_sign_autman.js`
|
|
- 实机 JS 副本：`js/qdreader_sign_autman.js`
|
|
- 定时运行：`cron: 1 7 * * *`，每日 07:01 自动签到；签到结束后立即归档并清空最近运行日志
|
|
- 手动运行：`启点签到` / `启点签到 <uid>`
|
|
- Cookie 维护：`启点账号` / `启点ck <cookie>` / `启点查询`
|
|
- 完全体任务：`启点任务` 菜单按需开启激励任务、每日任务、每日抽奖、每周兑换、章节卡片、大咖荐书；默认只执行签到 + 领取奖励
|
|
- v2.6.0：适配上游 QDReader 完全体任务框架，保留 Autman 单插件、独立 bucket、多用户隔离、手动只跑当前用户、cron 跑全部账号、运行后立即归档清日志。
|
|
|
|
Raw 导入：
|
|
|
|
```text
|
|
https://gitea.chickliu.fun/Hermes/autman-plugins/raw/branch/main/plugins/qdreader/qdreader_sign_autman.js
|
|
```
|
|
|
|
验证：
|
|
|
|
```bash
|
|
node tests/qdreader_plugin.test.mjs
|
|
```
|
|
|
|
## 文档
|
|
|
|
- [Autman 插件开发规则与仓库约定](docs/autman-plugin-rules.md)
|
|
- [JS 微服务路由插件模板](templates/js-router-plugin-template.js)
|
|
- [Python middleware 插件模板](templates/python-middleware-plugin-template.py)
|