| Oracle® Fusion Middleware Oracle API Managerの使用 12c (12.2.1.1.0) E79333-01 |
|
 前へ |
 次へ |
この章では、Oracle API Managerを使用したAPIの検出およびサブスクライブについて説明します。Oracle API Manager PortalにAPIを公開すると、API Consumerロールを持つユーザーはポータルを使用して、自分のアプリケーションで使用するAPIを見つけてサブスクライブすることができます。
内容は次のとおりです。
APIとして公開されたOracle Service Busプロキシ・サービスは、Oracle API Manager Portalに公開されます。API Manager Portalから、API Consumerロールを持つユーザーはAPIを見つけて調査し、サブスクライブして使用することができます。
ユーザーは、「サブスクリプション」ページを使用して自分のサブスクリプションを管理し、「カタログ」ページを使用して新しいAPIを見つけて調査します。
また、API Manager Portalを使用して、自分のアプリケーションでAPIを使用するのに必要な情報を探し出します。APIは、アプリケーションのコンテキストで使用します。公開されたAPIを使用する予定の各アプリケーションは、API Manager Portalに表示される必要があります。これにより、アプリケーションごとにAPIの管理およびサブスクリプション統計の収集が可能になります。
API Adminロールを持つユーザーは、API Manager Portalで追加のタスクを実行できます。これらのタスクの詳細は、「Oracle API Managerの管理」を参照してください。
この項では、API Manager Portalのサインインおよびログアウトについて説明します。
API Manager Portalにサインインするには:
http://example.com:7001/apimanager/など)にナビゲートします。APIを使用する予定の各アプリケーションは、API Manager Portalに表示される必要があります。
この項では、アプリケーションの作成、アプリケーションへのAPIのサブスクライブ、使用しなくなったアプリケーションのAPI Manager Portalからの削除について説明します。
APIをアプリケーションにサブスクライブするには、APIを使用する予定のアプリケーションに対応するアプリケーションをAPI Manager Portalで作成する必要があります。
「サブスクリプション」ページからアプリケーションを作成するには:
注意:
アプリケーションは、「カタログ」ページから作成することもできます。詳細は、「「カタログ」ページからのAPIへのサブスクライブ」を参照してください。
アプリケーションを作成したら、「サブスクリプション」ページからアプリケーションで使用するAPIにサブスクライブできます。
「サブスクリプション」ページからアプリケーションにAPIをサブスクライブするには:
注意:
「選択したAPI」リストでAPIにカーソルを合せ、APIの横にある「選択解除」アイコンをクリックすると、選択したAPIを削除できます。
「選択したAPI」リージョンで「クリア」アイコンをクリックすると、選択したAPIをすべて削除できます。
アプリケーションの説明を編集すると、API Manager Portalでの説明を変更できます。
アプリケーションの説明を編集するには:
API Consumerロールを持つユーザーは、API Manager Portalを使用してAPIを検索し、興味があるAPIに関連付けられたメタデータを確認して自分のアプリケーションでAPIが有用であるかどうかを判断できます。
ユーザーは「カタログ」ページから、非推奨にされていないAPIに直接サブスクライブできます。
API Manager Portalの「カタログ」ページを使用してアプリケーションで使用するAPIを検索します。「カタログ」ページから、各APIの詳細を表示してアプリケーションで使用するかどうかを決定できます。
APIを検索するには:
注意:
非推奨APIは選択できません。次の図に示すように、「非推奨」シンボルとともに表示されます。
「非推奨」シンボルにカーソルを合せると、APIが非推奨になった理由を読むことができます。
管理対象APIと管理対象外APIの違いの説明は、「管理対象APIと管理対象外APIの違いについて」を参照してください。
ヒント:
検索結果をクリアしてAPIの完全なリストを戻すには、次の図に示すように、「フィルタのクリア」アイコンをクリックします。
興味があるAPIを見つけたら、「詳細」ページを表示して関連付けられたメタデータを確認できます。
API詳細ページを表示するには:
API詳細ページにはAPIについて次のステータスが表示されます。
管理対象ステータス: APIが管理対象か管理対象外かを示します。
非推奨ステータス: APIが非推奨か非推奨以外かを示します。
API詳細ページには、次の分析が表示されます。
現在のAPIステータス: APIが稼働しているか停止しているかを示します。
エラー数: このAPIの起動時に受信したエラーの数が表示されます。
メッセージ数: APIから受信したメッセージの数が表示されます。
時間間隔: 表示されたデータが集計された時間を表示します。
平均レスポンス時間: 平均メッセージ・レスポンス時間(ミリ秒)が表示されます。集約間隔の変更の詳細は、『Oracle Service Busの管理』の「操作設定とグローバル設定の構成」を参照してください。
表示される分析は、「統計の表示」リストで選択したオプションによって決まります。「現在の集約間隔」を選択して現在の集約間隔(詳細ページに表示される「期間」)のみの分析を表示するか、「最後のリセット以降」を選択して最後のリセット以降の分析統計を表示します。
API詳細ページには、次のメタデータも表示されます。
| 要素 | 説明 |
|---|---|
APIプロファイル |
APIに関連付けられている基本的なメタデータが表示されます。 |
API URL |
APIのURLへのリンク。 |
バージョン |
APIのバージョン情報が表示されます。 |
説明 |
APIの機能の詳細説明が表示されます。 |
タグ |
APIに関連付けるタグのリストが表示されます。 |
管理 |
APIが管理対象か管理対象外かを示します。 |
SOAP |
関連付けられたWSDLファイルのリンクが表示されます。 注意: このリージョンは、WSDLベースのSOAP APIの場合のみ表示されます。 |
WSDL |
WSDLファイルへのリンクが表示されます。 |
OraWSDL |
該当する場合、OraWSDLファイルへのリンクが表示されます。 |
REST |
WADLファイルへのリンクが表示されます。 注意: このリージョンは、REST APIの場合のみ表示されます。 |
参照 |
APIの外部ドキュメント参照などの情報ソースが表示されます。 |
API詳細 |
APIの追加の詳細が表示されます。 |
セキュリティ概要 |
このAPIにアタッチするグローバル・セキュリティ・ポリシーの概要が表示されます。 |
セキュリティ・ポリシー |
このAPIにアタッチされたセキュリティ・ポリシーが表示されます。ポリシーにカーソルを合せて「詳細」アイコンをクリックすると、ポリシーの説明が表示されます。 |
非推奨 |
APIが非推奨か非推奨以外かを示します。 |
テスト中 |
APIのテストURLが表示されます。 |
「カタログ」ページからAPIに直接サブスクライブできます。
「カタログ」ページからAPIにサブスクライブするには:
「カタログ」ページで、サブスクライブする各APIの「選択」アイコンをクリックします。サブスクリプション用に複数のAPIを選択できます。
注意:
非推奨APIは選択できません。新しいサブスクリプションには使用できません。
次の図に示すように、「選択したAPI」リージョンで「サブスクライブ」ボタンをクリックします。
注意:
「選択したAPI」リストでAPIの横にある「選択解除」アイコンをクリックすると、選択したAPIを削除できます。「選択したAPI」リージョンで「クリア」アイコンをクリックすると、選択したAPIをすべて削除できます。次の図に、これらのアイコンを示します。
(オプション) 使用するアプリケーションがリストにない場合:
次の図に示すように、「作成」アイコンをクリックします。
アプリケーションの作成ダイアログで、「名前」フィールドにアプリケーションの名前を入力し、「説明」フィールドに説明を入力します。
「作成」ボタンをクリックしてアプリケーションを作成します。
選択するアプリケーションをクリックして、「選択」ボタンをクリックします。選択したAPIにサブクスライブされます。
次の2つの異なるビューを使用して、サブスクライブしているAPIを表示できます。
「サブスクリプション」ページの「API」パネル: サブスクライブしているAPIのリストを表示する場合に使用します。この詳細は、「サブスクライブされているAPIの表示」を参照してください。
「サブスクリプション」ページの「アプリケーション」パネル: 選択したアプリケーションがサブスクライブされているAPIを表示する場合に使用します。この詳細は、「特定のアプリケーションにサブスクライブされているAPIの表示」を参照してください。
サブスクライブされているAPIを表示するには、「サブスクリプション」ページで「API」をクリックします。サブスクライブされている各APIがリストに表示されます。名前、タグ、アプリケーション、キーおよび説明がAPIごとに表示されます。
ヒント:
「順序付け」リストを使用すると、次の基準に基づいてAPIをソートできます。
API名、降順
API名、昇順
アプリケーション名、降順
アプリケーション名、昇順
複数のアプリケーションが同じAPIにサブスクライブされている場合、次の図に示すように、そのAPIは、サブスクライブされているアプリケーションごとに1回ずつ、複数回リストに出現します。
この項では、管理対象APIと管理対象外APIの違い、APIのテスト、アプリケーションでのAPIの使用方法について説明します。
管理対象APIへのアクセスはアプリケーションの権限キーを使用して実行時に制御されます。このキーを指定しないでAPIをコールすると失敗します。詳細は、「管理対象外APIの使用方法」を参照してください。
管理対象APIを正常に起動するためには、まずアプリケーションを作成して該当する管理対象APIにサブスクライブします。次に、コールが成功するようにAPIキーをリクエスト・ヘッダーに指定して、クライアントでAPIを起動する必要があります。
管理対象外APIは、サブスクリプトしなくても、実行時に権限キーを渡さなくても起動できます。
分析は、管理対象APIにも管理対象外APIにも使用できます。このような詳細は、「API詳細ページに表示されるデータ」で説明されているように、API詳細ページの上部に表示されます。
管理対象外APIを使用するために実行する必要がある特別なアクションはありません。管理対象外APIにサブスクライブする必要も、実行時に権限キーを渡す必要もありません。アプリケーションで通常するように管理対象外APIを起動します。
管理対象APIを使用するには、まずそのAPIにサブスクライブする必要があります。APIへのサブスクライブの詳細は、「「サブスクリプション」ページからのAPIへのサブスクライブ」を参照してください。
API Manager Portalの各アプリケーションは、そのアプリケーションがサブスクライブされているAPIごとに実行時に渡す必要がある一意のキーを持っています。権限キーは、X-API-KEY属性を使用してHTTPユーザー・ヘッダーとして渡す必要があります。たとえば、アプリケーションの権限キーがb4a4cd59-744c-4a08-a888-6287ce6431c0の場合、コールが成功するように管理対象APIを起動するためには、属性X-API-KEY: b4a4cd59-744c-4a08-a888-6287ce6431c0がリクエスト・ヘッダーに存在する必要があります。
API Manager Portalでアプリケーションの権限キーを探す方法の説明は、「アプリケーションの権限キーの取得」を参照してください。
アプリケーションの権限キーは、「サブスクリプション」ページの該当するアプリケーションのエントリに表示されます。
アプリケーションの権限キーを探すには、「サブスクリプション」をクリックします。「アプリケーション」パネルで、権限キーを探すアプリケーションの名前をクリックします。次の図に示すように、アプリケーションの権限キーは「アプリケーション」リージョンに表示されます。
注意:
「管理対象APIの使用方法」で説明されているように、このキーを使用して管理対象APIを起動します。キーを使用せずに管理対象APIを起動すると、HTTPステータス・コード403 Forbiddenが表示されます。
ヒント:
アプリケーションのキーにカーソルを合せると、ツール・チップが表示されます。このツール・チップから、アプリケーションのキーが含まれるX-API-KEY属性を直接コピーできます。
API作成者は、テスト用のURLを提供できます。テストURLが提供され、API Curatorロールを持つユーザーがそのURLをAPIメタデータに追加して(「APIのメタデータの編集」を参照)いると、APIコンシューマはサブスクライブする前にAPIの機能をテストして評価できます。
APIをテストするには:
APIを使用しなくなった場合は、そのAPIからサブスクライブ解除できます。たとえば、APIが非推奨となって新しいバージョンを採用する場合やAPIがアプリケーションに合致しなくなったと判断した場合、そのAPIからサブスクライブ解除できます。
管理対象APIからサブスクライブ解除した後では、サブスクライブに使用されていたアプリケーションの権限キーを使用してそのAPIを起動しようとすると拒否されます。
この項では、APIからのサブスクライブ解除に使用する2つの方法について説明します。
「API」パネルを使用してAPIからサブスクライブ解除するには:
ヒント:
複数のアプリケーションがAPIにサブスクライブされている場合は、そのAPIのエントリが複数あります。サブスクリプションを削除するアプリケーションと合致するAPIエントリの「サブスクライブ解除」アイコンを必ずクリックしてください。
