1. Homepage
  2. API Experience Hub
  3. API Portal の管理

  4. API の管理

API の管理

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

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

  • AsyncAPI

  • HTTP

  • REST

  • SOAP

API 管理ページには、次の情報が表示されます。

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

    ポータルに追加されている API が表示されます。管理者が追加できるのは、「Exchange Viewer (Exchange 閲覧者)」権限を持つ API のみです。詳細は、​「管理者権限の割り当て」​を参照してください。API がポータルに追加されると、すべての管理者には「Exchange Viewer (Exchange 閲覧者)」権限が自動的に割り当てられます。API のデフォルトの表示は管理者です。ポータルの管理者はポータルタブの [APIs (API)] で各 API のこの表示を変更できます。これらの API は削除することもできます。

    ポータルでは最大 250 個の API を使用できます。詳細は、​「制限事項」​を参照してください。

  • APIs in Exchange (Exchange の API)

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

リスト内の API 名の下向き矢印をクリックすることで、API の説明を表示できます。

API の説明を表示

Exchange での API の表示

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

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

Exchange から API を追加する

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

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

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

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

  3. リストから API を選択し、その他のオプションアイコンをクリックして、​[Add to portal (ポータルに追加)]​ を選択します。

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

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

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

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

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

  3. リストから API を選択し、その他のオプションアイコンをクリックして、​[Remove from portal (ポータルから削除)]​ を選択します。

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

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

API バージョンを表示する

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

ユーザーがポータルで表示できる API のバージョンを管理できます。表示は [Administrators (管理者)]、[Members (メンバー)]、[Everyone (全員)]、または [None (なし)] に設定できます。

  • Administrators Only (管理者のみ)

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

  • Members Only (メンバーのみ)

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

  • Everyone (全員)

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

  • なし

    このオプションは、バージョンを誰にも表示しない場合に使用します。

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

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

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

  2. 名前で API を検索するには、​[Search (検索)]​ 項目に名前を入力します。

  3. リストから API を選択し、その他のオプションをクリックして、​[Edit display details (表示の詳細を編集)]​ を選択します。

  4. API バージョンの表示を変更するには、対応するバージョンの ​[Visibility (表示)]​ ドロップダウンリストからオプションを選択します。

  5. 変更を保存するには、​[Save (保存)]​ をクリックします。

次のステップ

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