APIキー

概要

General Translation で使用される API キーには 2 種類あります。

Production API Key：本番環境でコンテンツを翻訳する際に使用します。
Development API Key：開発環境でコンテンツを翻訳する際に使用します。

この 2 種類のキーは挙動が異なるため、自分がいる環境に合わせて正しいキーを使用するよう注意してください。

GT_PROJECT_ID=your-project-id
GT_API_KEY=your-api-key

gt-next や gt-react を単体の i18n ライブラリとして使用している場合、API キーを使用する必要はありません。

入手方法

General Translation website のプロジェクトダッシュボードに移動します。

「API Keys」または「Developer Keys」タブをクリックします。

「Create API Key」ボタンをクリックします。

APIキーをコピーし、プロジェクトの .env ファイルに貼り付けます。

挙動

簡単に言えば、Prod APIキーは翻訳を永続化し、Dev APIキーは永続化しません。 Dev APIキーは翻訳のプロトタイピングに使用し、Prod APIキーは本番環境でのデプロイ時に使用します。

開発用APIキー

このタイプのキーは、テストや開発目的に便利です。開発用APIキーを使用すると、翻訳はオンデマンドで行われ、メモリ内でメモ化されます。翻訳は保存されません。

開発用APIキーは、ブラウザでレンダリングされるコンポーネント（クライアントサイド）や、サーバーサイドでレンダリングされるコンポーネントでオンデマンド翻訳を実現するために使用されます。つまり、このキーはクライアントにエクスポートする必要があります。このキーは本番環境で絶対に使用してはいけませんし、本番環境でクライアントに渡してはいけません。

# dev用のVite .envファイル例
VITE_GT_PROJECT_ID=your-project-id
VITE_GT_API_KEY=your-dev-api-key # 開発時のみ使用

警告: 開発用APIキーは、開発時のクライアントサイド翻訳を実現するためにクライアントへ渡されます。これは開発環境では問題ありませんが、本番環境ではセキュリティリスクとなります。アプリケーションがインターネットに公開されている場合、開発用APIキーは絶対に使用しないでください。

本番用APIキー

本番用APIキーを使用すると、翻訳は永続化されます。つまり、翻訳は（CDNまたはアプリのバンドル内に）保存され、実行時に利用されます。

このキーは次の2箇所で使用されます：

gtx-cli ツール。詳細はドキュメントをご覧ください。
本番ビルド時にサーバーサイドで翻訳が行われる際の gt-next ライブラリ（gt-react では使用されません）。
- <Tx> および tx() 関数は、実行時にコンテンツを翻訳するために使用されます。

APIキーはサーバーのみで使用され、クライアントにエクスポートしてはいけません。

GT_PROJECT_ID=your-project-id
GT_API_KEY=your-prod-api-key # このキーはクライアントにエクスポートしてはいけません

注意事項

開発用APIキーはテストや開発目的で使用されます。開発環境でのみ使用してください。
本番用APIキーは本番環境で使用されます。

次のステップ

開発中にライブ翻訳を確認するには、<T> コンポーネントの使い方をご覧ください。
cli ツールの詳細については、使用ガイドをご参照ください。