APIキー

General TranslationでのAPIキーの使用方法

概要

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

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

この2種類のキーの動作は異なるため、使用している環境に適したキーを使用するよう注意してください。

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

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


取得方法

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

「APIキー」または「開発者キー」タブをクリックします。

「APIキーを作成」ボタンをクリックします。

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


動作

最も簡単に言えば、Prod APIキーは翻訳を永続化しますが、Dev APIキーは永続化しません。 翻訳のプロトタイプ作成にはDev APIキーを使用し、デプロイの準備ができたらProd APIキーを使用します。

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

次のステップ

このページについて