# General Translation Platform: API 密钥
URL: https://generaltranslation.com/zh/docs/platform/api-keys.mdx
---
title: API 密钥
description: 以细粒度权限管理身份验证密钥
---

API 密钥用于对应用程序、CI job 和自动化访问 General Translation 服务进行身份验证。你可以在项目级别为单个项目创建密钥，也可以在组织级别为需要更广泛访问权限的自动化创建密钥。

请在创建后立即复制完整密钥。控制台只会显示一次。

## 密钥范围

| 范围     | 最适合用于                          |
| ------ | ------------------------------ |
| **项目** | 单个项目、已部署的应用、本地开发、预览环境以及项目级工具   |
| **组织** | 组织级自动化、可跨项目运行的 CI，以及需要自定义权限的工具 |

项目密钥和组织密钥的创建流程不同。项目密钥分为生产密钥和开发密钥。组织密钥则使用权限选择器。

## 项目密钥

在 **Project -> API Keys** 中创建项目密钥。

| 类型       | 前缀         | 适用场景            |
| -------- | ---------- | --------------- |
| **生产环境** | `gtx-api-` | 已部署的应用和生产自动化    |
| **开发环境** | `gtx-dev-` | 本地开发、预览环境和测试自动化 |

项目密钥与所选项目绑定。在大多数项目 SDK 和 CLI 工作流中，请将此密钥与项目 ID 一起使用：

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

## 组织密钥

可在 **Organization -> API Keys** 中创建组织密钥。

组织密钥使用 `gtx-org-` 前缀，并且可以配置自定义权限集。可将其用于组织级自动化，或用于需要跨组织内多个项目运行的工作流程。

## 组织密钥权限

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

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

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

## 轮换或撤销密钥

打开项目或组织的密钥列表，查看现有密钥。撤销不再使用的密钥，并在轮换凭据时创建新的密钥进行替换。

## 安全实践

* 切勿将密钥提交到版本控制系统
* 将密钥存储在环境变量或密钥管理服务中
* 为开发、预发布和生产环境分别使用不同的密钥
* 定期轮换密钥，并撤销不再使用的密钥
* 在满足集成需求的前提下，尽量使用最小权限范围