API Manager - サブスクライバーポータルを使用すると、API サブスクライバーは次を実行できます。

  • 公開されたすべての API の表示
  • サブスクライブされたすべての API の表示
  • API の検索とカテゴリ別の表示
  • API がリクエストするパラメーターの表示
  • API キーの生成
  • SLA 層の選択
  • アプリケーションの作成
  • パブリッシャーからの通知の表示

ログイン

サブスクライバーポータルにログインするには:

  1. Web ブラウザーのアドレスバーに "<localhost or IP address>:<port number>/portal/" と入力します。

  2. ユーザー名およびパスワードを入力します。

  3. ログイン」をクリックします。

API の参照

ポータルに正常にログインすると、サブスクライブした API のリストを表示できます。

  1. 任意の API を選択します。

  2. API の詳細ページで、次のようなサブスクライブした API の説明を表示できます。

    • API の名前と説明
    • API のバージョン
    • API の表示
    • API のコンテキスト
    • API のライフサイクル
  3. 任意の API を選択します。API を試用するには、「試用」をクリックします。アプリケーションおよびリソースのコンテンツタイプを選択します。「API 呼び出しを実行」をクリックします。次の結果を表示できます。

すべての API の表示

このページでは、次のサブスクライブしたすべての API を表示できます。

API カタログ

このページでは、可視性と時間(最新または最古)に従って、サブスクライブしたすべての API をフィルターできます。バージョン、可視性、説明などと共に API を表示できます。

ColdFusion サーバーからの REST API の使用

パブリッシャーが ColdFusion サーバーから API を作成したら、API を使用およびテストできます。

  1. API カタログから API を選択します。

  2. 左側のパネルの「リソース」をクリックして、API の詳細を表示します。

  3. API をテストするには、「試用」をクリックします。アプリケーションを選択して、「API 呼び出しを実行」をクリックします。API が現在の日付を返すのを確認できます。「リクエスト詳細」タブおよび「レスポンス詳細」タブを展開して、URL およびステータスコードを表示します。

Swagger API の使用

API パブリッシャーが Swagger API を公開すると、API をテストしたり、アプリケーションで API を使用したりできます。API カタログに移動して、使用可能なすべての公開 API のリストを表示します。

  1. API カタログから API を選択します。

  2. 左側のパネルの「リソース」をクリックして、API の詳細を表示します。

  3. API をテストするリソースのメソッドを選択します。

  4. API をテストするには、「試用」をクリックします。petid の値を入力して、アプリケーションを選択します。「API 呼び出しを実行」をクリックします。

API 呼び出しの JSON 形式の応答を確認できます。次に例を示します。

SOAP API の使用

API パブリッシャーが SOAP API を公開すると、API を試用したり、アプリケーションで API を使用したりできます。API カタログに移動して、使用可能なすべての公開 API のリストを表示します。

  1. API のリストから試用したい API を選択します。

  2. API 詳細画面の左側のパネルの「この API をテスト」をクリックします。

  3. プロキシ WSDL、WSDL ポートタイプ、オペレーションを確認できます。また、REST エンドポイントおよびそのバインディングも確認できます。適切な SOAP タイプを選択します。

  4. SOAP 本文に BLZ コードを入力して、アプリケーションを選択します。例えば、BLZ コード 50040000 を入力します。「API 呼び出しを実行」をクリックします。

SOAP API が BLZ コード 50040000 を持つ銀行の名前を返すのを確認できます。応答は次のとおりです。

<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns1:getBankResponse
            xmlns:ns1="http://thomas-bayer.com/blz/">
            <ns1:details>
                <ns1:bezeichnung>Commerzbank</ns1:bezeichnung>
                <ns1:bic>COBADEFFXXX</ns1:bic>
                <ns1:ort>Frankfurt am Main</ns1:ort>
                <ns1:plz>60005</ns1:plz>
            </ns1:details>
        </ns1:getBankResponse>
    </soapenv:Body>
</soapenv:Envelope>

アプリケーションの作成

アプリケーションを作成して、アプリケーションにサブスクライブする API を取得できます。作成するアプリケーションの名前と説明を入力して、「アプリケーションを作成」をクリックします。

公開された API をサブスクライブしてから、アプリケーションで使用します。サブスクリプションにより、アクセストークンを受け取ることができ、API を呼び出すための認証を受けることができます。 

アプリケーションへのサブスクライブ

アプリケーションを作成したら、API をアプリケーションにサブクスライブする必要があります。API を選択し、左側のパネルの「サブスクライブ」をクリックします。アプリケーションを選択し、SLA プランを選択します。「サブスクライブ」をクリックします。サブスクライバーの SLA プランはパブリッシャーが選択します。

API のパブリッシャーの承認を待っているアプリケーションのリストを確認できます。また、サブスクリプションを変更および削除することもできます。

アプリケーションレベルでのスコープの認証

サブスクライバーの場合、アプリケーションを選択して、そのスコープを制限できます。

  1. アプリケーションをサブスクライブするには、「サブスクライブ」をクリックします。

  2. アプリケーションのセキュリティキーを確認するには、「アプリケーション」をクリックします。

    1 アプリケーションの名前。
    2 これは、タイプ apikey の認証を持つリソースのためのアプリケーションキーです。このキーが使用されると、API の本番エンドポイントがリクエストを受け取ります。
    3 これはアプリケーションキーと同じですが、このキーが使用されると、API のサンドボックスエンドポイントがリクエストを受け取ります。
    4 アプリケーションを一意に識別するクライアント ID です。基本認証または Oauth2 認証がある場合に使用されます。
    5 認証コード付与フローまたはクライアント資格情報フローを使用したトークンが取得されると、認証タイプが Oauth2 の場合、クライアント秘密キーが使用されます。これは、秘密にしておく必要があります。

    注意:

    セキュリティに対する配慮 - 項目 2、3 および 5 は、秘密にしておく必要があり、外部に公開してはいけません。これらのいずれかが漏洩した場合、キーを再生成すると、以前の漏洩したキーを無効にできます。新しく生成した資格情報をアプリケーションに使用します。資格情報を渡す場合は、HTTPS を使用します。

    「更新トークンのライフタイム」は、常に「アクセストークンのライフタイム」よりも長くなります。

    IDP メタデータ URL:SAML ID プロバイダーのメタデータ URL を指定します。SAML および OAuth 認証を使用して API のいずれかをサブスクライブし、IDP にメタデータをホストさせる場合、ここに IDP URL を入力します。

    IDP 生メタデータ:上記と同じです。ID メタデータがある場合、ここに XML を貼り付けます。

    これらの階層または承認に関連付けられた使用プランのみ、パブリッシャーに送られます。残りは自動的に承認されます。

サブスクリプションレベルでの API の承認

API リクエストは、管理者によってサブスクリプションリクエストが承認された場合にのみ、行われます。次の画像は、パブリッシャーからの API サブスクリプションの承認を示しています。

パブリッシャーがアプリケーションリクエストを承認すると、アプリケーションキーを確認できます。このキーを使用すると、リクエストを実行できます。

分析ダッシュボードの表示

サブスクライバー向けの分析ダッシュボードには、アプリケーション数、API リクエスト数、API エラーなどのビジュアライゼーションが含まれています。「分析」をクリックして、サブスクライバー分析ダッシュボードページを起動します。

サブスクライバーポータルには、3 種類のダッシュボードがあります。

  • アプリケーション
  • サブスクリプション
  • エラー

アプリケーション:アプリケーションパネルでは、次のビジュアライゼーションを表示できます。

1 アプリケーションに対するリクエスト数の円グラフ。
2 API リクエスト数。
3 アプリケーションリクエスト数の折れ線グラフ。
4 アプリケーションによる平均データ使用量を示す折れ線グラフ。
5 アプリケーションの平均応答時間を示す折れ線グラフ。

サブスクリプション:サブスクリプションパネルでは、次のビジュアライゼーションを表示できます。

1 サブスクリプション(アプリケーションおよび API)に対するリクエスト数の円グラフ。
2 API リクエスト数。
3 SLA プランに対するリクエスト数の円グラフ。
4 サブスクリプション(アプリケーションおよび API)に対するリクエスト数の折れ線グラフ。
5 SLA プランごとの最大スロットル制限のリスト。
6 平均データ使用量を示す折れ線グラフ。
7 サブスクリプションの平均応答時間を示す折れ線グラフ。

エラー:エラーパネルでは、次のビジュアライゼーションを表示できます。

1 サブスクリプションおよび SLA プランのエラー数。
2 異なるステータスコードのエラー数。
3 すべてのステータスコードに対するリクエストの折れ線グラフ。
4 上位 5 つのエラータイプを示す円グラフ。
5 最大エラー数による上位 10 リソースのリスト。

期間によるデータのフィルタリング

分析ページでは、期間に応じて結果をフィルタリングできます。

次の 3 つのオプションがあります。

  1. Quick(クイック)
  2. Relative(相対)
  3. Absolute(絶対)

期間によってデータをフィルタリングするには:

  1. 次に示すように、時間のフィルターをクリックします。

  2. 次に示すように、リストから期間を選択します。

    Today(今日)」を選択すると、過去 24 時間のすべての API の分析を確認できます。

  3. Relative(相対)」をクリックします。指定した日時から現在の日時までのデータをフィルタリングできます。

  4. Absolute(絶対)」をクリックします。日付に応じて結果をフィルタリングできます。

本作品は Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License によってライセンス許可を受けています。  Twitter™ および Facebook の投稿には、Creative Commons の規約内容は適用されません。

法律上の注意   |   プライバシーポリシー