HTTP 与 REST API 参考
IndexFlow 在 /api 和 /api/v1 下提供统一 REST API。
认证
所有受保护端点都要求包含有效 HMAC-SHA256 签名 JWT 的 if_token cookie：
Cookie: if_token=<YOUR_JWT_TOKEN>
1. 系统与健康状态
健康检查
- 方法与路由：
GET /health - 认证：无（公开）
- 响应：
200 OK
{
"db": "sqlite-wal",
"service": "indexflow-core",
"status": "healthy"
}
2. 仪表盘与统计
获取站点指标
- 方法与路由：
GET /api/v1/stats - 查询参数：
site_id（可选，整数）：目标站点 ID（默认1）。 - 响应：
200 OK
3. 流水线生命周期管理
支持的流水线阶段：sitemap（Sitemap 资源发现）、seo-gate（技术 SEO 与 GEO 预检质量门）、gsc-inspect（Google Search Console 检查）、bing-inspect（Bing Webmaster 检查）、push-submit（主动搜索引擎提交）。
启动流水线阶段
- 方法与路由：
POST /api/v1/pipeline/{stage}/start - 查询参数：
site_id（可选，整数）：目标站点 ID（默认1）。 - 响应：
200 OK（返回 HTMX 更新 HTML partial，并触发refreshTableheader）。
停止流水线阶段
- 方法与路由：
POST /api/v1/pipeline/{stage}/stop - 响应：
200 OK
同步 GSC Search Analytics 池（0 配额）
- 方法与路由：
POST /api/v1/pipeline/gsc-inspect/sync - 响应：
204 No Content
4. URL 检查与审计
检查单个 URL
- 方法与路由：
POST /api/v1/urls/{id}/inspect - 路径参数：
id（必需，整数）：URL 主键。 - 查询参数：
engine（必需，字符串）：seo|google|gsc|bing - 响应：
200 OK
批量检查 URL
- 方法与路由：
POST /api/v1/urls/batch-inspect - 请求体：
Content-Type: application/json，包含selected_ids和engine。 - 响应：
200 OK
5. 主动搜索引擎提交
提交单个 URL
- 方法与路由：
POST /api/v1/urls/{id}/submit - 查询参数：
provider（必需）：bing|google
批量提交 URL
- 方法与路由：
POST /api/v1/urls/batch-submit - 请求体：JSON，包含
selected_ids和provider。
6. 监控与 Watchlist
切换 URL 监控状态
- 方法与路由：
POST /api/v1/monitoring/{id}/watch - 请求体：JSON，包含
watched布尔值。
批量监控 / 取消监控 URL
- 方法与路由：
POST /api/v1/monitoring/batch-watch
7. 站点凭据测试
测试 Google 服务账号连接
- 方法与路由：
POST /api/v1/sites/test-google - 请求体：
service_account_json与domain。
测试 Bing Webmaster API 密钥
- 方法与路由：
POST /api/v1/sites/test-bing-webmaster
测试 Bing IndexNow 密钥文件
- 方法与路由：
POST /api/v1/sites/test-indexnow
8. 站点管理
删除站点
- 方法与路由：
POST /api/v1/sites/{id}/delete - 响应：
200 OK删除站点会级联删除关联的urls、health_checks、submission_logs和index_status_history记录。