1. Homepage
  2. API Experience Hub
  3. エクスペリエンスビルダーを使用したポータルのカスタマイズ

  4. API Experience Hub Lightning コンポーネント

API Experience Hub Lightning コンポーネント

ビルダーで Lightning コンポーネントを追加および設定することで、API Experience Hub ポータルのページを設計できます。

これらの Lightning コンポーネントには、すべての Salesforce デジタルエクスペリエンスで使用可能な Lightning コンポーネントと、API Experience Hub でのみ使用可能な API Experience Hub Lightning コンポーネントの両方が含まれます。

各 API Experience Hub Lightning コンポーネントには異なる設定オプションがあり、異なる機能がポータルに追加されます。

多くの API Experience Hub Lightning コンポーネントには、Anypoint Platform からのデータが表示されます。ポータル管理者は、これらのデータ項目の一部 (API 参照名、説明、アイコンなど) を変更できます。API Experience Hub はこれらの変更を保存しますが、変更を Anypoint Platform に転送しません。

API Experience Hub コンポーネントを追加する手順は、次のとおりです。

  1. [コンポーネント]​ 稲妻アイコンをクリックして、コンポーネントパレットを表示します。

  2. 任意のコンポーネントをコンポーネントパレットから現在のページにドラッグします。

  3. ページ内のコンポーネントを選択すると、そのコンポーネントの設定オプションが表示されます。

  4. コンポーネントのプロパティ項目に値を入力するか値を選択して、値を編集します。

コンポーネントを削除するには、削除アイコンをクリックして、ダイアログで ​[Delete (削除)]​ をクリックします。

API Console

対話型の API Console コンポーネントには REST API とそのメソッドに関する情報が表示されます。エンドポイントはアルファベット順に表示されます。

コンソールコンポーネントには、API Console、API Console Documentation (API Console ドキュメント)、API Console Instances (API Console インスタンス)、API Console Specification (API Console 仕様)、API Console Request Panel (API Console リクエストパネル) が含まれます。ビルダーで、同じページに複数のコンソールコンポーネントを追加できます。コンソールコンポーネントへの変更は、同じ API を表示するそのページの他のすべてのコンソールコンポーネントに表示されます。たとえば、API Console で [Summary (概要)] タブを選択すると、同じ API を表示する同じページのすべての API Console で [Summary (概要)] タブが選択されます。

このコンポーネントには、Anypoint Exchange からの公開 API インスタンスとドキュメントが表示されます。

API Console に表示する次のプロパティを選択します。

  • Expand endpoints (エンドポイントを展開)

Asset Detail Header (アセット詳細ヘッダー)

Asset Details Header (アセット詳細ヘッダー) コンポーネントは、アイコン、名前、連絡先メール、説明などが含まれる API ヘッダーを表示します。

表示される API アイコン、名前、説明は、コミュニティに API バージョンを追加するときに API Experience Hub のコントロールパネルで設定されます。連絡先メールは、Anypoint Exchange で設定されます。

[API details (API 詳細)]​ ページに表示する次のプロパティを入力または選択します。

  • Record ID (レコード ID)

  • Show API Contact (API 連絡先を表示)

  • Show API Clients (API クライアントを表示)

  • Show instance URL (インスタンス URL を表示)

  • Show categories (カテゴリを表示)

  • Show tags (タグを表示)

  • Show Request access button ([Request Access (アクセス権の要求)] ボタンを表示)

  • Show Download spec button ([Download spec (仕様をダウンロード)] ボタンを表示)

  • Show lifecycle state (ライフサイクル状態を表示)

アセットバージョン

1 つのバージョンのみが表示される場合、Exchange からの API バージョンが表示されます。

Version State (バージョンの状態)

API バージョンのライフサイクル状態が表示されます。

  • Asset Documentation Viewer (アセットドキュメントビューアー)

API Documentation Viewer (API ドキュメントビューアー) コンポーネントは、Anypoint Exchange からの API のドキュメントを表示します。ドキュメントは複数のページで構成され、各ページは複数のセクションで構成されることもあります。

API Carousel (API カルーセル) コンポーネントは、​[Home (ホーム)]​ ページに表示される水平方向にスクロール可能な API カードのセットを表示します。各カードには、API が表示されます。

次の Assets Carousel (アセットカルーセル) のプロパティの値を指定できます。

  • Title (タイトル)

    カルーセルのタイトル。

  • Subtitle (サブタイトル)

    カルーセルのタイトルの後に表示されるサブタイトル。

  • Cards to display (表示するカード数)

    カルーセルに表示する API カードの数。カルーセルには、最低 3 個、最大 15 個のカードを表示できます。表示するカードの数が 5 で、ポータルに API が 3 つしかない場合、カルーセルには 5 個ではなく 3 個のカードが表示されます。

API Carousel (API カルーセル) に表示されるタイトルとサブタイトルを変更できます。​[Subtitle (サブタイトル)]​ 項目に ​{numberOfAssets}​ 変数を入力して、サブタイトルにカードの数を表示することもできます。例: Latest APIs added {numberOfAssets} (追加された最新の API 数 {numberOfAssets})​。次の画像は、変数には ​[Cards to display (表示するカード数)]​ 項目で選択された番号が表示されるため、サブタイトルに​「Latest APIs added 5 (追加された最新の API 数 5)」​と表示されています。

Assets Carousel (アセットカルーセル) [Subtitle (サブタイトル)] オプションの画像

  1. [Manage your API portal (API Portal を管理)]​ ページで、​[Preview and publish your portal (ポータルをプレビューしてパブリッシュ)]​ をクリックします。

  2. [Home (ホーム)]​ ページで、​[Asset Carousel (アセットカルーセル)]​ 領域をクリックし、API Carousel (API カルーセル) コンポーネントを編集します。

  3. 項目に入力し、必要な情報を含めます。

  4. [Preview (プレビュー)]​ ボタンをクリックして変更内容を確認します。

  5. [Publish (パブリッシュ)]​ ボタンをクリックして変更内容をパブリッシュします。

API Carousel (API カルーセル) に表示する API カードの数を変更する手順は、次のとおりです。

  1. [Manage your API portal (API Portal を管理)]​ ページで、​[Preview and publish your portal (ポータルをプレビューしてパブリッシュ)]​ をクリックします。

  2. [Home (ホーム)]​ ページで、​[Asset Carousel (アセットカルーセル)]​ 領域をクリックし、API Carousel (API カルーセル) コンポーネントを編集します。

  3. [Cards to display (表示するカード数)]​ 項目で、リストから 3 ～ 15 の数値を選択します。

  4. [Preview (プレビュー)]​ ボタンをクリックして変更内容を確認します。

  5. [Publish (パブリッシュ)]​ ボタンをクリックして変更内容をパブリッシュします。

Assets Catalog (アセットカタログ)

API Catalog (API カタログ) コンポーネントは、API Portal で使用可能なすべての API を探索する対話的な方法を API コンシューマーに提供します。API Carousel (API カルーセル) には、ページに分割された行と列に API カード、および表示する API をタイプと検索語で絞り込むコントロールが表示されます。各カードには、API が表示されます。カタログを使用すると、ユーザーは多数の API バージョンを表示して探索できます。

Search Box (検索ボックス)

API Experience Hub の Search Box (検索ボックス) コンポーネントを使用すると、ユーザーは Salesforce Experience Cloud に存在するコンテンツ (ナレッジ記事、サポートケース、お知らせなど) および Anypoint Platform に存在するコンテンツ (API やクライアントアプリケーションなど) の両方を検索できます。ナレッジ記事、サポートケース、お知らせは現在使用できません。

Search Results (検索結果)

API Experience Hub の Search Results (検索結果) コンポーネントは、Search Box (検索ボックス) コンポーネントにユーザーが検索を入力した後の結果を表示します。

関連情報