> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qoder.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Teams OpenAPI 概览

> 面向外部集成方：Qoder Teams OpenAPI 的适用对象、阅读顺序、能力与前置条件。

本文档说明如何通过 **Qoder Teams OpenAPI** 在组织维度查询成员、用量与 AI 代码相关数据。所有接口均需使用 **API Key** 调用，且仅能访问该 Key 所属组织范围内的数据。

## 适用对象

* 组织 **管理员** 或受委托的 **集成 / 运维 / 数据** 人员，需在系统外自动化拉取 Teams 数据时阅读本文。
* 调用方应具备基本的 **HTTPS**、**JSON** 与 **REST** 使用经验。

## 建议阅读顺序

按官网侧边栏顺序阅读即可与集成步骤一致：

1. **[约定与规范](/zh/account/teams/openapi/conventions)** — 接入点、认证、分页、错误格式与字段命名。
2. **[获取 API Key](/zh/account/teams/openapi/get-api-key)** — 在控制台创建密钥。
3. **[API Key 安全](/zh/account/teams/openapi/api-key-security)** — 保管、轮换与泄露处置。
4. **[成员 API](/zh/account/teams/openapi/members)** — 成员列表、详情、统计、配额与相关管理接口。
5. **[用量 API](/zh/account/teams/openapi/usage)** — Credits 用量事件与汇总；组织级用量事件。
6. **[AI 代码指标与追踪](/zh/account/teams/openapi/ai-code-metrics)** — 聚合统计、提交归因及明细 / 导出。

## 能力与范围（摘要）

| 类别   | 说明                                                         |
| ---- | ---------------------------------------------------------- |
| 鉴权   | 请求头 `Authorization: Bearer <api_key>`，Key 与组织绑定。           |
| 数据范围 | 仅可访问该 Key 对应组织下的数据；具体字段以各接口说明为准。                           |
| 基础路径 | 组织相关接口以 `/v1/organizations/{organization_id}` 为前缀（详见约定文档）。 |

<Warning>
  API Key 与创建人具备**同类资源访问与操作能力**（在产品与权限模型允许范围内）。请勿将密钥提交到仓库、聊天或邮件中明文传播。
</Warning>

## 组织 ID

调用前请从 Qoder Web 控制台组织设置或组织 URL 中获取 **`organization_id`**（下文示例中用 `org_xxx` 表示占位符，请替换为实际值）。

## 获取帮助

若接口返回错误，请记录响应体中的 **`requestId`** 并向 Qoder 支持提供该 ID，便于排查。