# General Translation Platform: API 键
URL: https://generaltranslation.com/zh/docs/platform/dashboard/reference/api-keys.mdx
---

title: API 键
description: 为应用、本地开发和自动化创建并管理项目和组织 API 键。

---

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

## 键层级 [#key-scopes]

GT 支持两种 API 键层级：

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

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

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

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

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

| 资源                      | Read                    | Write 或启用后         |
| ----------------------- | ----------------------- | ------------------ |
| **Files**               | 读取项目文件和译文               | 上传源内容并写入翻译后的文件     |
| **Context**             | 读取项目和 Organization 的上下文 | 管理上下文组、词汇表和指令      |
| **Runtime translation** | 不适用                     | 按需翻译内容             |
| **Translation queue**   | 不适用                     | 将文件翻译任务加入队列以进行后台处理 |
| **Project settings**    | 不适用                     | 更新默认区域设置等项目“设置”    |

仅为每个键授予其所需的权限。

## 创建 Project 键 [#create-project-keys]

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

* **Production 键** 以 `gtx-api-` 开头。
  * 用于已部署的应用和生产自动化流程。生产环境中的翻译使用已发布内容。
* **Development 键** 以 `gtx-dev-` 开头。
  * 用于本地开发、预览环境和测试自动化。Development 键 可让你在发布前测试翻译，而不会影响线上应用。
  * 不要在生产环境中使用 Development 键。

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

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

## 管理键 [#manage-keys]

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

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

* **预览**，用于识别的截断后键
* **创建时间**，键的生成时间
* **上次使用时间**，键最近一次使用的时间
* **删除**，用于撤销不再需要的键

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

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

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