2.8 KiB

Raw Blame History

API文档

本目录包含GEO平台的API接口文档，共33个API模块。

文档内容

认证API - 用户认证相关接口
品牌API - 品牌管理接口
内容API - 内容生成接口
知识库API - 知识库接口
诊断API - SEO/GEO诊断接口
健康检查 - 系统健康检查接口
监测优化API - 监测数据分析接口
告警通知API - 告警通知管理接口
仪表盘API - 仪表盘数据接口
查询词API - 查询词管理接口
引用数据API - 引用数据管理接口
报告API - 报告生成接口
Agent管理API - Agent管理接口
生命周期API - 生命周期管理接口
内容管理API - 内容管理接口
客户管理API - 客户管理接口
内容分发API - 内容分发接口
优化建议API - 优化建议接口
引导流程API - 引导流程接口
平台规则API - 平台规则管理接口
图片生成API - 图片生成接口
组织管理API - 组织管理接口
检测任务API - 检测任务接口
GEO方案API - GEO方案生成接口
AI引擎查询API - AI引擎查询接口
效果追踪API - 效果追踪监测接口
竞品分析API - 竞品分析接口
Schema建议API - Schema标记建议接口
趋势洞察API - 趋势洞察接口
API Key管理API - API Key管理接口
用量追踪API - 用量追踪接口

诊断模块API

诊断模块提供3个核心端点：

端点	描述	状态
`GET /api/v1/diagnosis/seo/{brand_id}`	获取品牌的SEO诊断结果	✅ 已完成
`GET /api/v1/diagnosis/geo/{brand_id}`	获取品牌的GEO诊断结果	✅ 已完成
`GET /api/v1/diagnosis/combined/{brand_id}`	获取品牌的SEO+GEO综合诊断结果	✅ 已完成

详细说明请查看诊断模块说明。

API基础信息

基础URL: http://localhost:8000
API版本: v1
认证方式: Bearer Token (JWT)
响应格式: JSON

通用响应格式

{
  "success": true,
  "data": {},
  "message": "操作成功",
  "error": null
}

错误响应

{
  "success": false,
  "data": null,
  "message": "错误描述",
  "error": {
    "code": "ERROR_CODE",
    "details": {}
  }
}

认证

除健康检查外，所有API都需要认证：

curl -H "Authorization: Bearer <token>" http://localhost:8000/api/v1/...