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

用語集

最終更新日: Mar 20, 2020

API Gateway を使用する前に、以下の用語を理解することをお勧めします。

期間 説明
アプリ ユーザーは API を呼び出すための ID としてアプリを作成する必要があります。
AppKey, AppSecret 各アプリにはキーペアがあり、暗号化され、リクエストの署名情報として使います。
暗号化された署名 API リクエストには、API Gateway がリクエストした側の ID を認証するための安全な署名情報が含まれます。
許可 API サービスプロバイダは、API を呼び出す権限をアプリに付与します。 許可されたアプリだけが API を呼び出すことができます。
API ライフサイクル API サービスプロバイダは、API の作成、検証、公開、非公開、バージョンの切り替えなど、API の各環境を管理します。
API 定義 API サービスプロバイダは API を作成する際、バックエンドサービス、リクエスト形式、受取形式、レスポンス形式といった API のルールを設定する必要があります。
パラメーターのマッピング ユーザー リクエスト内のパラメーターが API バックエンドのパラメーターと一致しない場合、API サービスプロバイダはパラメーター マッピングを設定できます。
パラメーターバリデーション API サービスプロバイダは入力パラメーターのバリデーションルールを設定します。 ルールに基づいて、API Gateway は無効なリクエストをフィルタリングします。
固定パラメーター パラメーターの入力は必須ではありませんが、バックエンドサービスは常にそのパラメーターを受け取る必要があります。
システムパラメーター バックエンドに送信されるリクエストに CaClientIP(リクエスト IP アドレス)といった特定のシステム パラメーターが含まれるようゲートウェイを設定できます。
API グループ API サービスプロバイダは、グループで API を管理します。 API を作成する前に、まずグループを作成する必要があります。
サブドメイン グループを作成する際、API 呼び出しのテストのために、システムはグループにサブドメインをバインドします。
独自ドメイン API を公開するときは、独自ドメインをグループにバインドする必要があります。 ユーザーが API を呼び出すには、独自ドメインにアクセスする必要があります。
署名鍵 API サービスプロバイダは、署名鍵を作成して API にバインドすることができます。 サービスプロバイダのバックエンドにリクエストを送信する際、ゲートウェイはバックエンド セキュリティ検証のために署名情報を保持します。
スロットリング ポリシー API サービスプロバイダは、スロットリング ポリシーを使用して、分、時間、または日単位で API、ユーザー、およびアプリのトラフィックを管理します。