Amazon API Gateway
開発者ガイド

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

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

  • API キーを要求するよう API メソッドを設定します。

  • リージョンの API 用に API キーを作成またはインポートします。

API キーを設定するには、事前に API を設定し、それをステージにデプロイしている必要があります。

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

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

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

API キーを要求する API メソッドを設定するには

  1. AWS マネジメントコンソールにサインインして API Gateway コンソール (https://console.aws.amazon.com/apigateway/) を開きます。

  2. API Gateway メインナビゲーションペインで、[Resources] を選択します。

  3. [Resources] で、新しいメソッドを作成するか、既存のメソッドを選択します。

  4. [Method Request] を選択します。

  5. [Authorization Settings] セクションで、[API Key Required] に、[true] を選択します。

  6. チェックマークアイコンを選択して、設定を保存します。

  7. API をデプロイまたは再デプロイして要件を満たします。

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

API キーの作成

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

API キーを作成するには

  1. AWS マネジメントコンソールにサインインして API Gateway コンソール (https://console.aws.amazon.com/apigateway/) を開きます。

  2. API Gateway メインナビゲーションペインで、[API Keys] を選択します。

  3. [Actions] ドロップダウンメニューから、[Create API key] を選択します。

     使用プランの API キーの作成
  4. [Create API Key] で、以下の操作を行います。

    1. [Name] 入力フィールドに、API キー名 (例: MyFirstKey) を入力します。

    2. [Auto Generate] を選択してキー値を生成する API Gateway を取得するか、[Custom] を選択して、キーを手動で入力します。

    3. [Save] を選択します。

     使用プランの API キーの作成
  5. 必要に応じてさらに API キーを作成するには、前述の手順を繰り返します。

API キーのインポート

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

API キーをインポートするには

  1. メインナビゲーションペインで、[API Keys] を選択します。

  2. [Actions] ドロップダウンメニューから、[Import API keys] を選択します。

  3. カンマ区切りのキーファイルをロードするには、[Select CSV File] を選択します。 また、キーを手動で入力できます。 ファイル形式の詳細については、「API Gateway API キーファイルの形式」を参照してください。

     API 使用量プランのエンティティ
  4. エラーが発生した場合、[Fail on warnings] を選択してインポートを停止するか、[Ignore warnings] を選択して、エラーが発生した場合に、有効なキーエントリのインポートを継続します。

  5. 選択した API キーのインポートを開始するには、[Import] を選択します。

API キーをセットアップしたので、「create and use a usage plan」に進むことができます。