API Gateway コンソールを使用して API キーをセットアップする

API キーを設定するには、以下の作業を行います。

API キーを設定するには、事前に API を設定し、それをステージにデプロイしている必要があります。API キー値は、作成後に変更することはできません。

API Gateway コンソールを使用して API を作成し、デプロイする方法については、「API Gateway での REST API の開発」および「Amazon API Gateway での REST API のデプロイ」をそれぞれ参照してください。

API キーを作成したら、これを使用量プランに関連付ける必要があります。詳細については、「API Gateway コンソールで使用量プランを作成、設定、テストする」を参照してください。

考慮すべきベストプラクティスについては、「API キーと使用量プランのベストプラクティス」を参照してください。

メソッドで API キーを要求する

次の手順では、API キーを要求する API メソッドを設定する方法について説明します。

必要な API キーのオプションを false に設定し、上記の手順を実行しない場合、そのメソッドに対しては API ステージに関連付けられている API キーが使用されません。

使用量プランで使う API キーをすでに作成またはインポートした場合、この手順および次の手順を省略できます。

https://console.aws.amazon.com/apigateway で API Gateway コンソールにサインインします。
REST API を選択します。
API Gateway のメインナビゲーションペインで、[API キー] を選択します。
[API の作成] を選択します。
[ロール名] に名前を入力します。
(オプション) [説明] に説明を入力します。
[API キー] では、[自動生成] を選択して API Gateway にキー値を生成させるか、[カスタム] を選択して独自のキー値を作成します。
[Save] を選択します。

次の手順は、使用プランで API キーをインポートする方法について説明します。

https://console.aws.amazon.com/apigateway で API Gateway コンソールにサインインします。
REST API を選択します。
メインナビゲーションペインで、[API キー] を選択します。
[アクション] ドロップダウンメニューから、[API キーのインポート] を選択します。
カンマ区切りのキーファイルをロードするには、[ファイルの選択] を選択します。テキストエディターにキーを入力します。ファイル形式の詳細については、「API Gateway API キーファイルの形式」を参照してください。
警告が発生した場合、[警告を失敗とみなす] を選択してインポートを停止するか、[警告を無視する] を選択して、エラーが発生した場合に、有効なキーエントリのインポートを継続します。
[インポート] を選択して API キーをインポートします。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

API キーのソースを選択する

API Gateway コンソールで使用量プランを作成、設定、テストする