# General Translation Platform: API キー
URL: https://generaltranslation.com/ja/docs/platform/dashboard/reference/api-keys.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: アプリ、ローカル開発、自動化向けの プロジェクト および Organization の API キーを作成、管理します。API キーのリファレンス。

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

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

General Translation は 2 つの API キー のスコープをサポートしています。

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

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

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

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

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

| Resource              | Read                              | Write or enabled                  |
| --------------------- | --------------------------------- | --------------------------------- |
| **プロジェクトの作成**         | 該当なし                              | Organization 内に新しいプロジェクトを作成する     |
| **プロジェクトの API キー**    | プロジェクトの API キーを表示する               | プロジェクトの API キーを表示・作成する            |
| **Files**             | プロジェクトのファイルと翻訳を読み取る               | ソースコンテンツをアップロードし、翻訳済みファイルを書き込む    |
| **Context**           | プロジェクトと 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 キー** から プロジェクト キーを作成します。キー全体をすぐにコピーし、環境変数、シークレットマネージャー、またはその他の安全な保存先に保管してください。

* **本番用キー** は `gtx-api-` で始まります。
  * ファイルのアップロード、翻訳ジョブ、本番環境の自動化で使用します。ダッシュボードで作成したキーにはデフォルトの プロジェクト 権限が付与されます。Organization API で作成したキーは、委譲される権限がより少ない場合があります。
* **開発用キー** は `gtx-dev-` で始まります。
  * ローカル開発中のオンデマンド翻訳で使用します。デフォルトの権限はランタイム翻訳であり、本番専用のエンドポイントでは拒否されます。
  * 本番環境では開発用キーを使用しないでください。

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

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

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

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

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

* **Name** と **Key** (識別しやすいように短縮表示されたキーを含む)
* **権限** (Organization keys の場合)
* **Created**、キーが生成された日時
* **Last Used**、キーが最後に使用された日時

キーを管理する権限がある場合は、**Edit key** でキーの名前を変更したり、Organization key の権限を更新したりでき、**Delete** で失効できます。完全なシークレットはキーの作成時にのみ表示されます。

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

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

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

## Sitemap

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