Amazon API Gateway
開発者ガイド

API キーを使用する使用量プランの作成と使用

API を作成し、テストして、デプロイすると、API Gateway 使用量プランを使用して、顧客への提供商品として使用できるようになります。ビジネス要件および予算の制約に合った承認済みのリクエストレートとクォータで顧客に、選択した API へのアクセスを許可する使用量プランと API キーを設定できます。必要に応じて、API のデフォルトのメソッドレベルのスロットリング制限を設定したり、個別の API メソッドのスロットリング制限を設定したりできます。

使用量プランおよび API キーとは

使用量プランは、デプロイされた 1 つ以上の API ステージとメソッドにアクセスできるユーザーを指定します。また、API にアクセスできる量と速度を指定します。このプランは、API キーを API クライアントを特定し、各キーの関連付けられた API ステージへのアクセスを測定します。これを使用して、スロットリング制限とクォータ制限を設定できます。これらは、個々のクライアント API キーに適用されます。スロットリング制限は、使用量プランに追加した各 API キーに適用されるリクエスト率の制限です。API のデフォルトのメソッドレベルのスロットリング制限を設定したり、個別の API メソッドのスロットリング制限を設定したりすることもできます。クォータ制限は、指定した期間内に送信できる API キーを持つリクエストの最大数です。個別の API メソッドを、使用量プラン設定に基づく API キー認証を要求するように設定できます。API ステージは、API 識別子とステージ名によって識別されます。

API キーは、顧客のアプリケーション開発者に配布する API へのアクセスを許可する英数字の文字列です。API キーを使用量プランまたは Lambda オーソライザーと一緒に使用して、API へのアクセスを制御します。ユーザーに代わって API Gateway が API キーを生成することも、CSV ファイルからインポートすることもできます。

API キーを複数の使用量プランと関連付けることができます。使用量プランを複数のステージと関連付けることができます。ただし、指定された API キーを API の各ステージの 1 つの使用量プランにのみ関連付けることができます。

注記

スロットリングとクォータ制限は、使用プランのすべての API ステージについて集約される個々の API キーのリクエストに適用されます。

API Gateway で API キーを生成することも、外部ソースから API Gateway にインポートすることもできます。詳細については、「API Gateway コンソールを使用して API キーをセットアップする」を参照してください。

使用量プランを設定するステップ

以下のステップは、API 所有者として、顧客のために使用量プランを作成し、設定する方法を示します。

使用プランを設定するには

  1. 1 つ以上の API を作成し、API キーを要求するメソッドを設定して、ステージに API をデプロイします。

  2. API を使用するアプリケーションの開発者 (顧客) に配布する API キーを生成またはインポートします。

  3. 目的のスロットリングとクォータ制限を持つ使用プランを作成します。

  4. 使用量プランに、API ステージと API キーを関連付けます。

API の呼び出し元は、API へのリクエストの x-api-key ヘッダーで、割り当てられた API キーを指定する必要があります。

注記

使用量プランに API メソッドを含めるには、個別の API メソッドを、API キーを要求するように設定する必要があります。ユーザーの認証と許可のために、API キーを使用しないでください。IAM ロール、Lambda オーソライザー、または Amazon Cognito ユーザープールを使用します。