API マネージメント は、Web API を作成して公開し、その使用状況を監視・分析し、セキュリティポリシーを適用して誤使用を保護するための機能を含みます。
Magic xpi は、消費される API として HTTP と OData エンドポイントを公開するためのサポートを提供します。
|
Magic xpiはTyk API管理ツールと統合されています。 Tykについての詳細は https://tyk.io/ を参照してください。 |
Magic xpi の API マネージメント ダイアログボックスは 2 つのペインで構成されています。左側のペインは、トリガ エンドポイント ペインで、利用可能なエンドポイントのリストが表示されます。右側のペインには、各エンドポイントの API の詳細と、各エンドポイントの公開、再公開、または公開解除のオプションが表示されます。
エンドポイント一覧
エンドポイントセクションには、利用可能なエンドポイントのリストを含むテーブルがあります。このテーブルには、以下の列があります。
名前 |
内容 |
エンドポイント名 |
これは、サービスに対して定義されたエンドポイント設定の一部として追加されたエンドポイントの名前です。 |
公開 |
このカラムｊは、エンドポイントがAPI管理サーバーに公開されているかどうかを表示します。 エンドポイントが公開されている場合、値はYesに設定され、公開されていない場合はNoに設定されます。 |
API ID |
エンドポイントが公開されている場合はAPI IDが生成され、この欄に表示されます。 |
エンドポイントの詳細
トリガーの詳細セクションでは、選択したエンドポイントの詳細を設定することができます。エンドポイントの設定には、以下の詳細を設定することができます。(太字のパラメータは必須)
名前 |
内容 |
API名 |
API Gateway Server上のAPIエントリを識別するための有効かつ一意なAPI名。一意性を保つのはユーザーの責任です。一意性はAPI Gatewayサーバーによって検証されません。 |
リッスンパス |
API 管理サーバーがリッスンするリッスンパス。これは API Gateway エンドポイントになり、この HTTP または OData エンドポイントにマップされます。API 管理サーバーは、このリッスンパスからのリクエストをこのエンドポイントに転送します。 |
ターゲット URL |
APIがリダイレクトされるターゲットURLです。 コピーボタンを使用すると、ターゲットURLをクリップボードにコピーすることができます。 |
API URL |
エンドポイントのAPI URL。これはAPIが利用可能なURLです。 コピーボタンを使用すると、API URLをクリップボードにコピーすることができます。 |
認証 |
API管理サーバーとエンドポイント間の認証モード。認証の種類は以下の通りです。
|
ユーザー名 |
API管理サーバでBasic認証を行う際に必要なユーザ名の値です。 基本認証タイプの認証の場合に表示されます。 |
パスワード |
API 管理サーバで Basic 認証を行う際に必要なパスワードの値です。 基本認証タイプの認証の場合に表示されます。 |
トークン |
API管理サーバで認証トークン認証を行う際に必要なトークンです。 このフィールドは、認証が 基本認証 または 認証トークンタイプの場合に表示されます。 コピー ボタンを押すと、トークンをクリップボードにコピーすることができます。 |
トリガーの詳細ページには、以下のボタンがあります。
ボタン |
説明 |
発行 |
このボタンをクリックすると、エンドポイントをAPI管理サーバーに公開します。APIが公開されると、Publish欄の値がYesに設定され、API IDが取得されてエンドポイントに設定されます。 |
再発行 |
このボタンは、公開されたエンドポイントに対して表示されます。これにより、ユーザーは変更されたエンドポイントを再公開し、API管理サーバーとの同期を保つことができます。 |
公開の解除 |
このボタンをクリックすると、API管理サーバーからエンドポイントの公開を解除します。 APIの公開が解除されると、Published欄の値がNoになり、エンドポイントからAPI IDが削除されます。 |
|
Magic xpi のエンドポイントと API マネージメント サーバーのエンドポイントを同期させるのはユーザーの責任です。Magic xpiからエンドポイントを削除した場合は、API管理サーバーからエンドポイントを削除する必要があります。エンドポイントがAPI管理サーバーから削除された場合、エンドポイントの詳細セクションのAPI ID欄から生成されたAPI IDが削除され、公開欄の値がNoに設定されます。 |
また、API管理ページには以下のボタンがあります。
ボタン |
説明 |
サーバー設定 |
このボタンをクリックすると、サーバー設定ダイアログボックスが開きます。ここでは、API管理サーバーのサーバー設定を定義することができます。 これらのサーバー設定の定義方法の詳細については、ここをクリックしてください。 |
閉じる |
このボタンをクリックして、API管理設定ダイアログを終了します。 |
Since version:4.12
