すべてのプロダクト
Search
ドキュメントセンター

API Gateway:APIのHTTPSベースの呼び出しを有効にする

最終更新日:Nov 05, 2024

HTTPとSSL (Secure Sockets Layer) プロトコルに基づいて、HTTPSは送信されたデータを暗号化することによって安全な方法でデータを送信するために使用されます。 HTTPSは今日広く使用されています。

API Gatewayを使用すると、HTTPSを使用してAPIを呼び出すために開始されるリクエストを暗号化できます。 HTTP、HTTPS、またはその両方を介した呼び出しのみをサポートするように特定のAPIを設定できます。 APIでHTTPSベースの呼び出しをサポートする場合は、次の手順を実行します。

ステップ1: 準備をする

次の準備を実行します。

  • 独立したドメイン名を取得します。

  • 独立ドメイン名のSSL証明書を申請します。

  • 証明書をAPI Gatewayコンソールにアップロードします。 SSL証明書は、証明書 (XXXXX.pem) と秘密鍵 (XXXXX.key) で構成されます。 両方が入っている必要があります。API GatewayのTengineサービスはnginxに基づいており、nginxは PEM形式。

XXXXX.keyとXXXXX.pemはどちらもテキストエディターで開くことができます。 次の図に例を示します。

キー:

-----BEGIN RSA PRIVATE KEY-----
MIIEpAIBAAKCAQEA8GjIleJ7rlo86mtbwcDnUfqzTQAm4b3zZEo1aKsfAuwcvCud
....
-----END RSA PRIVATE KEY-----

PEM:

-----BEGIN CERTIFICATE-----
MIIFtDCCBJygAwIBAgIQRgWF1j00cozRl1pZ+ultKTANBgkqhkiG9w0BAQsFADBP
...
-----END CERTIFICATE-----	

手順2: SSL証明書をAPIグループにバインドする

API Gatewayコンソールにログインします。 左側のナビゲーションウィンドウで、[APIの管理] > [APIグループ] を選択します。 SSL証明書をバインドするAPIグループをクリックして、グループの詳細ページに移動します。 証明書のバインドを容易にするために、独立したドメイン名をAPIグループにバインドします。

[独立ドメイン] セクションにSSL証明書を追加します。

  • Certificate Name: 証明書の名前。 簡単に識別できるように、有益な名前を設定することをお勧めします。

  • 証明書の内容: 証明書の完全な内容。 XXXXX.pemファイルの内容をこのフィールドにコピーします。

  • 秘密鍵: 証明書の秘密鍵。 XXXXX.keyファイルの内容をこのフィールドにコピーします。 [OK] をクリックします。

ステップ3: API設定の調整

SSL証明書をAPIグループにバインドした後、APIに設定されているProtocolパラメーターを調整できます。 Protocolパラメーターの有効な値は、HTTP、HTTPS、およびHTTPとHTTPSです。 APIごとに1つ以上のプロトコルを選択できます。 セキュリティ上の考慮事項として、APIにHTTPSを選択することを推奨します。

  1. API Gatewayコンソールにログインします。 左側のナビゲーションウィンドウで、[APIの管理] > [API] を選択し、管理するAPIを見つけます。

  2. APIの名前をクリックします。 表示されるページで、右上隅の [編集] をクリックします。

  3. [基本情報] ステップで、[次へ] をクリックします。 [APIリクエストの定義] ステップで、[プロトコル] パラメーターを設定します。

    image

Protocolパラメーターを次の値に設定できます。

  • HTTP: APIはHTTP経由のアクセスのみをサポートします。

  • HTTPS: APIはHTTPS経由のアクセスのみをサポートします。

  • HTTPとHTTPS: HTTPとHTTPSの両方のリクエストをサポートします。 APIにHTTPSを選択すると、APIはHTTPSベースの呼び出しをサポートします。