开发者文档

开发者文档

品牌官网GEO 提供 RESTful API，支持将 GEO 能力集成到您自己的系统中。

认证方式

所有 API 请求需在 Header 中携带 JWT Token：

Authorization: Bearer <your_token>

Token 通过登录接口获取，有效期 30 天。

基础信息

• Base URL: https://web.zhdao.cn/api/v1
• 请求格式: application/json（登录接口除外，使用 OAuth2 表单格式）
• 响应格式: JSON
• 字符编码: UTF-8

核心接口

1. 用户注册

POST /auth/register

请求体：

{
  "email": "user@example.com",
  "password": "your_password",
  "name": "用户名"
}

返回：Token + 角色

2. 用户登录

POST /auth/login

请求体（OAuth2 表单格式）：

username=user@example.com&password=your_password

返回：Token + 角色

3. 获取当前用户

GET /auth/me

返回：用户信息（邮箱、角色、租户 ID）

4. 品牌管理

GET /brands - 获取品牌列表

POST /brands - 接入新品牌

PUT /brands/{id} - 更新品牌信息

DELETE /brands/{id} - 删除品牌

5. 站点体检

POST /brands/{id}/audit - 触发六维体检

GET /brands/{id}/metrics - 获取体检指标

6. AI 采样

POST /brands/{id}/sample - 触发多引擎采样

GET /brands/{id}/samples - 获取采样结果

7. 品牌事实库

GET /brands/{id}/facts - 获取事实列表

POST /brands/{id}/facts - 新增事实

PUT /facts/{id} - 更新事实

DELETE /facts/{id} - 删除事实

8. 站点内容（公开）

GET /content - 获取所有站点内容

GET /content/{key} - 获取指定内容（如 about、contact）

错误码

• 200 - 成功
• 201 - 创建成功
• 400 - 请求参数错误
• 401 - 未认证或 Token 过期
• 403 - 无权限
• 404 - 资源不存在
• 422 - 请求体验证失败
• 500 - 服务器内部错误

速率限制

体验版：60 次/小时 | 成长版：600 次/小时 | 旗舰版：无限制

SDK 规划

Python SDK 和 JavaScript SDK 正在开发中，届时可通过包管理器直接安装。

最后更新：2026 年 8 月 | API 版本：v1