本文档说明如何通过 Qoder Teams OpenAPI 在组织维度查询成员、用量与 AI 代码相关数据。所有接口均需使用 API Key 调用,且仅能访问该 Key 所属组织范围内的数据。
适用对象
- 组织 管理员 或受委托的 集成 / 运维 / 数据 人员,需在系统外自动化拉取 Teams 数据时阅读本文。
- 调用方应具备基本的 HTTPS、JSON 与 REST 使用经验。
建议阅读顺序
按官网侧边栏顺序阅读即可与集成步骤一致:
- 约定与规范 — 接入点、认证、分页、错误格式与字段命名。
- 获取 API Key — 在控制台创建密钥。
- API Key 安全 — 保管、轮换与泄露处置。
- 成员 API — 成员列表、详情、统计、配额与相关管理接口。
- 用量 API — Credits 用量事件与汇总;组织级用量事件。
- AI 代码指标与追踪 — 聚合统计、提交归因及明细 / 导出。
能力与范围(摘要)
| 类别 | 说明 |
|---|
| 鉴权 | 请求头 Authorization: Bearer <api_key>,Key 与组织绑定。 |
| 数据范围 | 仅可访问该 Key 对应组织下的数据;具体字段以各接口说明为准。 |
| 基础路径 | 组织相关接口以 /v1/organizations/{organization_id} 为前缀(详见约定文档)。 |
API Key 与创建人具备同类资源访问与操作能力(在产品与权限模型允许范围内)。请勿将密钥提交到仓库、聊天或邮件中明文传播。
组织 ID
调用前请从 Qoder Web 控制台组织设置或组织 URL 中获取 organization_id(下文示例中用 org_xxx 表示占位符,请替换为实际值)。
获取帮助
若接口返回错误,请记录响应体中的 requestId 并向 Qoder 支持提供该 ID,便于排查。