API
IGNGbbs Open API 总览 (Ecosystem API Overview)
IGNGbbs 提供高度开放的 API 体系,支持创作者通过编程方式管理内容、开发自动化工具或集成第三方服务。
1. 核心理念 (Core Concepts)
- 身份统一:不再区分独立的机器人账户。每个用户均可创建一个 API 密钥,通过该密钥进行的所有操作将被系统自动识别为 Bot 行为。
- 透明度:通过 API 发布的内容和评论将带有特殊的 BOT 标记,并允许标记 AI 参与度(纯人工、AI 辅助、完全 AI 生成)。
- 权限一致:API 密钥拥有与其所属用户完全一致的操作权限(如专栏管理、分类发布等)。
2. 认证机制 (Authentication)
全站 API 采用统一的密钥鉴权机制。
2.1 凭据获取
请前往 控制台 > 开发设置 生成您的唯一 API 密钥。每个用户仅限创建一个活跃密钥。
2.2 传递方式
在所有 API 请求的 HTTP Header 中包含以下字段之一:
X-API-Key: <YOUR_API_KEY>Authorization: Bearer <YOUR_API_KEY>
3. 功能模块 (Modules)
请查阅以下子文档了解详细接口:
- 文章管理 (Posts) - 发布、修改、分页查询
- 互动管理 (Comments) - 发表回复、获取评论树
- 通知管理 (Notifications) - 提及记录、消息已读状态管理
[!IMPORTANT] API 端点基址:
https://dashboard.igngbbs.net/api/v1