API Keys

General Translation での APIキー の使い方

概要

General Translation で使用する API Keys には 2 種類あります:

  • 本番用 APIキー: 本番環境でコンテンツを翻訳する際に使用します。
  • 開発用 APIキー: 開発環境でコンテンツを翻訳する際に使用します。

この 2 種類のキーは動作が異なるため、利用する環境に応じて正しいキーを選択してください。

GT_PROJECT_ID=プロジェクトID
GT_API_KEY=APIキー

gt-next または gt-react をスタンドアロンの i18n ライブラリとして使用している場合、APIキーを使う必要はありません。


取得方法

General Translation のウェブサイトで、該当プロジェクトのdashboardに移動します。

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

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

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


動作

簡単に言うと、Prod API Keys は翻訳を保存しますが、Dev API keys は保存しません。 Dev API keys は翻訳の試作に、Prod API Keys はデプロイ準備が整った段階で使用します。

開発用APIキー

この種のキーはテストや開発用途に有用です。 開発用APIキーを使用すると、翻訳はオンデマンドで実行され、メモリ上にメモ化されます。 翻訳は保存されません

開発用APIキーは、ブラウザでレンダリングされるコンポーネント(クライアントサイド)およびサーバーサイドでレンダリングされるコンポーネントでのオンデマンド翻訳を行うために使用されます。 つまり、このキーはクライアントへ公開(エクスポート)する必要があります。 このキーは本番環境で決して使用せず、本番環境でクライアントに渡してはなりません。

# 開発用の 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 Keys はテストおよび開発目的で使用します。開発環境でのみ使用してください。
  • 本番用の API Keys は本番環境で使用します。

次のステップ

このガイドはいかがですか?