1. ホームページ
  2. API Experience Hub
  3. ポータルの管理

  4. API の管理

API の管理

[API Management (API 管理)]​ ページで、Exchange からの API に関する情報を表示して、API の追加または削除を行い、API バージョンの表示を変更することで、ポータルを選定します。

ポータルでは、次の API 種別がサポートされます。

  • AsyncAPI

  • HTTP

  • REST

  • SOAP

[API Management (API 管理)]​ ページには、次の情報が表示されます。

  • APIs in the portal (ポータルの API)​

    ポータルに追加されている API が表示されます。管理者が追加できるのは、「Exchange Viewer (Exchange 閲覧者)」権限を持つ API のみです。詳細は、『権限の割り当て』を参照してください。

すべてのシステム管理者には、ポータルに追加されたすべての API に対する「Exchange Viewer (Exchange 閲覧者)」権限が自動的に割り当てられます。デフォルトでは、API の表示は [Administrators (管理者)] に設定されています。ポータル管理者は、​[APIs in the portal (ポータルの API)]​ タブで API の表示設定を変更したり、API を削除したりできます。

+ ポータルでは最大 350 個の API を使用できます。

  • APIs in Exchange (Exchange の API)

    Exchange 組織に存在するが、ポータルにはまだ追加されていない API が表示されます。

Exchange での API の表示

Exchange から直接 API に関する情報を表示して、ポータルで API を追加するかどうかを判断できます。

[APIs in Exchange (Exchange の API)]​ タブで、リストから API を選択し、その他のオプションアイコンをクリックして、​[View in Exchange (Exchange で表示)]​ を選択します。

Exchange から API を追加する

Exchange から API を追加することで、API Experience Hub でポータルを選定します。API をポータルに追加するには、Exchange に API が必要です。ポータルに API を追加する場合、デフォルトの表示は [Administrators (管理者)] です。メンバーまたは全員が含まれるように表示を変更できます。詳細は、​「API バージョンを表示する」​を参照してください。

ポータルに API を追加する手順は、次のとおりです。

  1. [API management (API 管理)]​ ページで、​[APIs in Exchange (Exchange の API)]​ タブを選択します。

  2. 名前または説明で API を検索するには、​[Search (検索)]​ バーに名前または説明を入力します。

  3. リストで API を見つけて、​[+] (ポータルに追加)​ をクリックします。

    API は ​[APIs in the portal (ポータルの API)]​ タブのリストに表示されます。

ポータルから API を削除する

ポータルから API を削除する手順は、次のとおりです。

  1. [API management (API 管理)]​ ページで、​[APIs in the portal (ポータルの API)]​ タブを選択します。

  2. API を検索するには、名前、説明、カテゴリ、またはタグキーワードを ​[Search (検索)]​ ボックスに入力します。

  3. リストで API を見つけて、ゴミ箱 (ポータルから削除) をクリックします。

  4. [Confirm (確認)]​ をクリックします。

    [APIs in the portal (ポータルの API)]​ タブで、API がリストから削除されます。

API バージョンを表示する

デフォルトでは、新しい API を追加すると、管理者と共有されているマイナーバージョンが最新バージョンの API になります。API インスタンスの表示は [Public (公開)] インスタンスに設定されます。エンドユーザーがアクセス権を要求できるのは、Exchange でパブリッシュされている API インスタンスのみです。

ユーザーがポータルで表示できる API のバージョンを管理できます。表示は [Administrators (管理者)]、[Members (メンバー)] およびユーザーグループ、[Guests (ゲスト)]、または [None (なし)] に設定できます。

  • Administrators (管理者)

    このオプションは、バージョンをポータル管理者のみに表示する場合に使用します。

  • Members (メンバー)

    このオプションは、バージョンをログイン済みのメンバーまたは特定のユーザーグループのみに表示する場合に使用します。

  • Guests (ゲスト)

    このオプションは、バージョンを公開して誰にでも表示する場合に使用します。

  • なし

    全員にバージョンを非表示にするには、ユーザーなしを選択します。

表示が [Guests (ゲスト)]、[Members (メンバー)]、またはユーザーグループである場合、コンシューマー開発者は、新しい API バージョンをポータルの API Carousel (API カルーセル) で表示できます。

API について表示されるユーザーの表示を編集する手順は、次のとおりです。

  1. [API management (API 管理)]​ ページで、​[APIs in Portal (ポータルの API)]​ を選択します。

  2. API を検索するには、名前、説明、カテゴリ、またはタグキーワードを ​[Search (検索)]​ ボックスに入力します。

  3. リストで API を見つけて、​[Edit visibility (表示を編集)]​ をクリックします。

  4. API インスタンスオプションを選択します。

    • All instances (すべてのインスタンス) - エンドユーザーは API へのアクセスを要求できません。

    • Public instances (公開インスタンス) - エンドユーザーが API へのアクセスを要求できます。

  5. API バージョンを展開し、API を表示できるユーザーを選択します。

  6. [Save (保存)]​ をクリックします。

次のステップ

『[User Management (ユーザー管理)』]​ から、ユーザーと、ゲストユーザーからのアクセス権の要求を表示して管理できます。