メニュー
Amazon API Gateway
開発者ガイド

API Gateway REST API を使用して API キーをセットアップする

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

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

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

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

REST API コールが API を作成し、デプロイするようにするには、「restapi:create」と「deployment:create」をそれぞれ参照してください。

メソッドの API キーが必要

メソッドの API キーを要求するには、次のいずれかを実行します。

  • method:put を呼び出してメソッドを作成し、リクエストペイロードで、apiKeyRequiredtrue に設定します。

  • method:update を呼び出して、apiKeyRequiredtrue に設定します。

API キーの作成またはインポート

API キーを作成またはインポートするには、次のいずれかを実行します。

API キーが作成できたら、「API Gateway REST API を使用したテスト使用量プランの作成、設定、テスト」に進むことができます。