API キーを取得する
コンソールで組織とアプリを作成し、SDK の呼び出しに使う client_id と client_secret を取得します。
SDK の呼び出しには認証情報が必要です。このガイドでは、次のガイド — はじめての SDK
呼び出し — で使う client_id と client_secret を、約 2 分で
取得します。
client_id と client_secret は何のためのものか
以下で取得する client_id/client_secret のペアは、POST /auth/token の Basic 認証用
資格情報です — ブラウザの SDK が使う短期のユーザーごとの session JWT を発行する、推奨の方法
です(認証モードを選ぶ 参照)。あなたの backend はこれを
Authorization: Basic base64(client_id:client_secret) として送信し、プラットフォームはあなたの
アプリの allowed_pipelines にスコープされた JWT を返します。
これらは、サーバー限定の API キーモードで使う x-api-key と同じ資格情報ではありませんし、
JWT の signing secret でもありません。自分のサーバーに統合する
に記載されている(レガシーな、代替の)自己署名 JWT 方式を選ぶ場合、その経路には別の
secret — アプリごとの signing secret — が必要で、これはこのコンソールのフローからは一切発行され
ません。プラットフォームの運営者が out-of-band で、安全なチャネルを通じて発行するもので、
POST /auth/token を呼ぶ代わりに意図的に自己署名を選ぶ場合にのみ必要になります。
静的な x-api-key はどうなるのか
このガイドでは session-JWT モード向けの client_id/client_secret ペアを扱います — ほとんどの
統合にとって推奨の経路です。静的な x-api-key は、同じアプリに対する別の、セルフサービスの
資格情報です。コンソールでアプリの詳細ページを開き、「API Key」カードの下にある Regenerate
API Key をクリックしてください。キーは一度だけ表示されます。サーバーの secrets ストアに
保管してください。
client_id/client_secret(POST /auth/token を通じて短期の JWT と交換するもの)とは異なり、
x-api-key はすべての呼び出しでヘッダーとして直接使います — 発行ステップは不要です。同じアプリに
スコープされます。呼び出せるのはそのアプリの allowed_pipelines 一覧にあるパイプラインのみで、
課金先も session JWT と同様にそのアプリの org wallet です。トレードオフはユーザーごとの帰属です —
どの呼び出しも特定のユーザーではなく「アプリ」からのものに見えます。ユーザーごとの帰属が重要な
場合は、代わりに session JWT モードを使ってください。完全な比較については 認証モードを選ぶ
を参照してください。
1. コンソールにサインインする
コンソール を開いてサインインするか、アカウントを作成してください (50 クレジット無料、クレジットカード不要)。
2. 組織を作成する
組織を作成します。あなたがそのオーナーになります。組織はアプリ・利用状況・課金を保持します。
3. アプリケーションを作成する
Applications → New application で名前を付けます。このアプリが、あなたのサーバーが SDK を 呼び出す際の身元になります。
4. client_id と client_secret をコピーする
client_id と一度限りの client_secret が表示されます。secret は一度だけ表示されます —
すぐにサーバーの secrets ストアにコピーしてください。ブラウザのコードや公開リポジトリに含めることは
絶対にしないでください。
5. パイプラインを有効化する
Tools へ進み、パイプライン(まずは translate-string から)を選んで、Enable onto application を
クリックします。これでアプリの allowed_pipelines 許可リストに追加されます — SDK(および
POST /auth/token で発行された任意の JWT)はアプリが有効化したパイプラインしか呼び出せません。
次へ:はじめての SDK 呼び出し では、この
client_id/client_secret のペアを使って実際に翻訳を呼び出します。