# General Translation Platform: API 键
URL: https://generaltranslation.com/zh/docs/platform/dashboard/reference/api-keys.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: 为应用、本地开发和自动化创建并管理项目和组织 API 键。API 键参考。

API 键用于让你的应用、CLI 和自动化访问 General Translation 时完成身份验证。请使用既能满足工作流需求、层级又尽可能小的键。

## 键层级 [#key-scopes]

General Translation 支持两种 API 键层级：

* **Organization 键** 用于 Organization 层级的自动化。可用于组织层级的自动化任务，或需要在 Organization 内跨多个项目运行的工作流。
* **项目 键** 用于单个项目。可用于已部署的应用、本地开发、预览环境以及项目层级的工具。

Organization 键 和项目 键 的创建流程不同。项目 键 需要创建为生产键或开发键。Organization 键 则使用权限选择器。

## 创建 Organization 键 [#create-organization-keys]

在 **Organization > Developer > API 键** 中创建 Organization 键。Organization 键使用 `gtx-org-` 前缀，并且可配置自定义权限集。

权限按资源分别配置。`Write` 包含 `Read`。

| 资源                    | Read                    | Write 或启用后              |
| --------------------- | ----------------------- | ----------------------- |
| **项目创建**              | 不适用                     | 在 Organization 中创建新项目   |
| **项目 API 键**          | 查看项目的 API 键             | 查看并创建项目 API 键           |
| **文件**                | 读取项目文件和译文               | 上传源内容并写入翻译后的文件          |
| **上下文**               | 读取项目和 Organization 的上下文 | 管理上下文组、词汇表和自定义提示词       |
| **运行时翻译**             | 不适用                     | 按需翻译内容                  |
| **Translation queue** | 不适用                     | 将文件翻译任务加入队列以进行后台处理      |
| **项目“设置”**            | 不适用                     | 更新默认区域设置和 CDN 交付等项目“设置” |

为调用 [创建项目](/docs/platform/openapi/reference/project/create-project) 端点 的自动化 启用 **项目创建**。当该自动化创建启用了 CDN 交付的项目时，也请启用 **项目“设置”**。仅为每个键授予其所需的权限。

对于调用 [创建项目 API 键](/docs/platform/openapi/reference/project/create-api-key) 的自动化，请将 **项目 API 键** 设置为 **Write**。该 端点 接受一个名称以及可选的 生产 或 开发 密钥类型，但不接受自定义权限。创建出的键将获得其类型的默认权限，且不会超出发起请求的身份所持有的项目权限范围。发起请求的身份可以是 Organization 键或 OAuth 用户访问令牌；项目键无法持有所需的 `project:api_keys:write` 权限。

## 创建 项目 键 [#create-project-keys]

在 **项目 > API 键** 中创建 项目 键。请立即复制完整键，并将其存储到环境变量、密钥管理器或其他安全存储中。

* **Production 键** 以 `gtx-api-` 开头。
  * 用于文件上传、翻译任务和生产自动化流程。在仪表板中创建的键拥有默认的 项目 权限；通过 Organization API 创建的键委派的权限可能更少。
* **Development 键** 以 `gtx-dev-` 开头。
  * 用于本地开发期间的按需翻译。其默认权限为运行时翻译；仅限生产环境的端点会拒绝此类键。
  * 不要在生产环境中使用 Development 键。

在大多数 SDK 和 CLI 工作流中，请将该密钥与项目 ID 一起使用：

```bash
GT_API_KEY=gtx-api-...
GT_PROJECT_ID=...
```

## 管理键 [#manage-keys]

使用便于理解的名称，方便后续识别键。

打开项目或 Organization 的键列表以查看现有键。键列表会显示：

* **名称** 和 **键**，其中键为便于识别的截断形式
* **权限**，仅适用于 Organization 键
* **创建时间**，键的生成时间
* **上次使用时间**，键最近一次使用的时间

如果拥有管理键的权限，可使用 **Edit key** 重命名键或更新 Organization 键 的权限，使用 **删除** 撤销该键。完整密钥仅在创建键时显示一次。

撤销不再使用的键，并在轮换凭据时创建新的替代键。

## 安全实践 [#security-practices]

* 切勿将键提交到版本控制系统。
* 将键存储在环境变量或机密管理器中。
* 开发、预发布和生产环境应使用不同的键。
* 定期轮换键。
* 吊销不再使用的键。
* 优先采用能满足集成需求的最小层级。

## Sitemap

See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.