# General Translation Platform: API キー
URL: https://generaltranslation.com/ja/docs/platform/dashboard/reference/api-keys.mdx
---
title: API キー
description: アプリ、ローカル開発、オートメーション向けの Project および Organization の API キーを作成、管理します。

---

API キーは、アプリ、CLI、オートメーションを General Translation で認証するために使用します。ワークフローに適した範囲で、最も限定的なキーのスコープを使用してください。

## キーのスコープ [#key-scopes]

GT は 2 つの API Key のスコープをサポートしています。

* Organization レベルの自動化には **Organization キー** を使用します。Organization 内の複数の Project をまたいで動作する必要がある、組織レベルの自動化や workflow に使用してください。
* 単一の Project には **Project キー** を使用します。デプロイ済みアプリ、ローカル開発、プレビュー、Project スコープのツールに使用してください。

Organization キー と Project キー では作成フローが異なります。Project キー は Production キーまたは 開発用キー として作成されます。Organization キー では Permission セレクターを使用します。

## Organization キーを作成する [#create-organization-keys]

**Organization > API キー** から Organization キーを作成します。Organization キーでは `gtx-org-` プレフィックスを使用し、カスタムの権限セットを設定できます。

権限はリソースごとに設定されます。`Write` には `Read` が含まれます。

| Resource                | Read                              | Write or enabled                 |
| ----------------------- | --------------------------------- | -------------------------------- |
| **Files**               | プロジェクトのファイルと翻訳を読み取る               | ソースコンテンツをアップロードし、翻訳済みファイルを書き込む   |
| **Context**             | プロジェクトと Organization のコンテキストを読み取る | コンテキストグループ、用語集、ディレクティブを管理する      |
| **Runtime translation** | 該当なし                              | 必要に応じてコンテンツを翻訳する                 |
| **Translation queue**   | 該当なし                              | バックグラウンド処理のためにファイル翻訳ジョブをキューに追加する |
| **Project settings**    | 該当なし                              | デフォルトロケールなどのプロジェクト設定を更新する        |

各キーには、必要な権限だけを付与してください。

## Project キーを作成する [#create-project-keys]

**Project > API キー** から Project キーを作成します。キー全体をすぐにコピーし、環境変数、シークレットマネージャー、またはその他の安全な保存先に保管してください。

* **本番用キー** は `gtx-api-` で始まります。
  * デプロイ済みアプリケーションや本番環境の自動化で使用します。本番の翻訳には公開済みコンテンツが使われます。
* **開発用キー** は `gtx-dev-` で始まります。
  * ローカル開発、プレビュー環境、テスト自動化で使用します。開発用キーを使えば、本番環境のアプリケーションに影響を与えることなく、翻訳が公開される前にテストできます。
  * 本番環境では開発用キーを使用しないでください。

ほとんどの SDK と CLI のワークフローでは、キーを Project ID と組み合わせて使用します:

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

## キーを管理する [#manage-keys]

後から見分けやすいように、キーにはわかりやすい名前を付けてください。

既存のキーを確認するには、Project または Organization のキー一覧を開きます。キー一覧には次の項目が表示されます。

* **Preview**、識別しやすいように短縮表示されたキー
* **Created At**、キーが生成された日時
* **Last Used**、キーが最後に使用された日時
* **Delete**、不要になったキーを無効化するための操作

使われなくなったキーは無効化し、認証情報をローテーションする際は置き換え用のキーを作成してください。

## セキュリティのベストプラクティス [#security-practices]

* キーをソース管理にコミットしないでください。
* キーは環境変数またはシークレットマネージャーに保存してください。
* 開発、ステージング、本番環境ではそれぞれ別のキーを使用してください。
* キーは定期的にローテーションしてください。
* 不要なキーは失効させてください。
* 連携に必要な範囲で、できるだけ限定的なスコープを選んでください。