文档

本地 REST API

MPPro 运行时会在本机启动一个 HTTP 服务,把采集到的数据以 REST 接口开放出来, 你可以把它接进自己的系统、脚本或看板。

服务地址

默认监听 http://127.0.0.1:18923,仅本机可访问, 不对外暴露,也不会把你的数据上传到任何服务器。

访问控制

默认不启用鉴权。如需保护,可在软件「设置」中开启 API Token, 之后每个请求需带上 Authorization 头。

完整清单

运行软件后访问 /api 可查看全部接口清单, 软件内「API 文档」页也提供交互式说明。

接口一览

主要接口

文章数据

GET/api/articles文章列表,支持公众号、日期范围、关键词筛选与分页
POST/api/articles/delete批量删除文章
GET/api/content-tasks正文采集任务列表
POST/api/content-tasks创建正文采集任务
POST/api/content-tasks/stop停止正文采集

公众号与统计

GET/api/accounts公众号列表及各号采集概况
POST/api/accounts新增公众号
DELETE/api/accounts/{nickname}删除指定公众号
GET/api/stats/overview全局统计概览
GET/api/stats/account单个公众号的统计分析数据

任务与导出

POST/api/tasks/start-manual手动开始采集任务
POST/api/tasks/stop-manual停止手动采集
POST/api/tasks/pause暂停当前任务
POST/api/tasks/resume继续当前任务
POST/api/tasks/stop停止任务
POST/api/export按条件导出数据(xlsx / csv / txt / md / html / pdf)

定时任务

GET/api/schedules定时任务列表
POST/api/schedules创建定时任务
POST/api/schedules/{id}/toggle启用 / 停用指定任务
DELETE/api/schedules/{id}删除指定任务

系统与设置

GET/api/health健康检查
GET/api/sysinfo系统与环境信息
GET/api/settings读取当前设置
POST/api/settings修改设置
GET/api/log运行日志

示例

怎么调用

curl

curl "http://127.0.0.1:18923/api/articles?limit=10"

Python

import requests

resp = requests.get(
    "http://127.0.0.1:18923/api/articles",
    params={"limit": 10},
)
for row in resp.json()["items"]:
    print(row["title"], row["read_num"])

接口字段以软件内「API 文档」页的实时清单为准;版本升级时若有字段调整, 会在更新日志中说明。