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

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

ログイン

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

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

  2. 表示されるフィールドにユーザー名とパスワードを入力します。

  3. 「Login to portal(ポータルにログイン)」をクリックします。

API の参照

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

  1. 任意の API をクリックします。

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

    • API の説明
    • API のバージョン
    • API の表示(プライベート、パブリック、パートナー)
    • API のライフサイクル
    • API の階層
    • 認証タイプ
    • API リソース

    任意のリソースを選択して、API リソース情報およびパスを表示します。

  3. API を試用するには、「Try Out(試用)」をクリックします。アプリケーションおよびリソースのコンテンツタイプを選択します。「Run API call(API 呼び出しを実行)」をクリックします。次の結果が表示されます。

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

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

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

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

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

    注意:

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

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

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

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

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

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

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

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

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

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

サブスクライバーポータルには、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 の規約内容は適用されません。

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