API コミュニティマネージャー Lightning コンポーネントの説明

Anypoint API コミュニティマネージャーの Search Box (検索ボックス) コンポーネントを使用すると、ユーザーは Salesforce Experience Cloud に存在するコンテンツ (ナレッジ記事、サポートケース、お知らせなど) および Anypoint Platform に存在するコンテンツ (API やクライアントアプリケーションなど) の両方を検索できます。検索の結果は、​ACM Search Results (ACM 検索結果)​ コンポーネントに表示されます。

API コミュニティマネージャーの Search Box (検索ボックス) の次のパラメーターの値を指定できます。

[Result Page URL (結果ページ URL)]​ パラメーターで検索結果ページの URL を指定します。検索結果を表示するには、検索結果ページに ​ACM Search Results (ACM 検索結果)​ コンポーネントを含める必要があります。ページに ​ACM Search Results (ACM 検索結果)​ コンポーネントが含まれていない場合、検索を入力してページに移動したメンバーとゲストユーザーには結果が表示されません。

[Search Areas (検索領域)]​ パラメーターでコンテンツタイプが選択されていない場合、リンクされた ​ACM Search Results (ACM 検索結果)​ コンポーネントではそのコンテンツタイプの結果が省略されます。MuleSoft Government Cloud では、API 仕様またはドキュメントページでの検索はサポートされていません。

[Enable advance links (高度なリンクを有効化)]​ を選択するときは、タブセット ID 項目が API の詳細ページのタブのカスタマイズ (​Console Tab Set Id​、​Documentation Tab Set Id​、​Custom fields Tab Set Id​、​Applications Tab Set Id​ など) と一致するように設定します。

コミュニティのデフォルトページには、1 つの ACM Search Box (ACM 検索ボックス) および 1 つの ACM Search Results (ACM 検索結果) コンポーネントがあります。これは、設定ミスの可能性を最小限に抑えるためのベストプラクティスですが、コミュニティのメンバー内の個別の利用者に対して個別の検索を使用することができます。

検索結果は、最後に変更された日付 (新しい日付から古い日付の順序) で並び替えられます。

検索設定と結果ページの表示をテストおよびプレビューするには、​API コミュニティをプレビュー​して検索を実行します。

API コミュニティマネージャーの Search Results (検索結果) コンポーネントは、​ACM Search Box (ACM 検索ボックス)​ コンポーネントにユーザーが検索を入力した後の結果を表示します。

Search Results (検索結果) の次のパラメーターの値を指定できます。

[Enable advance links (高度なリンクを有効化)]​ を選択するときは、タブセット ID 項目が API の詳細ページのタブのカスタマイズ (​Console Tab Set Id​、​Documentation Tab Set Id​、​Custom fields Tab Set Id​、​Applications Tab Set Id​ など) と一致するように設定します。

API Access Requester (API アクセスリクエスター) コンポーネントでは、コミュニティメンバーが新規または既存のアプリケーションで API へのアクセスをリクエストできます。

少なくとも 1 つの公開管理 API インスタンスの​表示が Exchange で公開に設定​されている場合、API ページに ​[API Access Request (API アクセス要求)]​ ボタンが表示されます。

コミュニティメンバーは、既存のクライアントアプリケーションと API インスタンスへのアクセスをリクエストするか、またはアプリケーション名と説明を指定して API インスタンスを選択することで、API にアクセスできる新規クライアントアプリケーションを作成するようにリクエストできます。

コンシューマー開発者が ID プロバイダー (IDP) を含む API インスタンスに対して新しいクライアントアプリケーションへのアクセス権を要求する場合、コンシューマー開発者は OAuth 2.0 許可種別である Authorization Code Grant (認証コード許可)、Implicit Grant (暗黙的許可)、Refresh Token (更新トークン)、Resource Owner Grant (リソースオーナー許可) の 1 つ以上を指定する必要があります。一部の IDP では、サポートされていない許可種別もあります。アクセスを要求し、サポートされていない許可種別を指定すると、エラー ​Error creating application.​ が表示されます。

API Access Requester (API アクセスリクエスター) の次のパラメーターの値を指定できます。

API Card (API カード) コンポーネントは、API または API グループに関する情報 (アイコン、名前、説明など) を表示します。

表示されるアイコン、名前、説明は、​コミュニティに API または API グループバージョンを追加​するときに API コミュニティマネージャーのコントロールパネルで設定されます。

API Card (API カード) の次のパラメーターの値を指定できます。

API Carousel (API カルーセル) コンポーネントは、水平方向にスクロール可能な API カードのセットを表示します。各カードには、API または API グループが表示されます。

表示される API アイコン、名前、説明は、​コミュニティに API バージョンを追加​するときに API コミュニティマネージャーのコントロールパネルで設定されます。

API Carousel (カルーセル) の次のパラメーターの値を指定できます。

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

API カタログ検索と ​ACM Search Box (ACM 検索ボックス)​ コンポーネントを使用して実行する検索は、同じ検索ではありません。API カタログ検索は API と API グループの基本的な検索であり、ACM Search Box (ACM 検索ボックス) コンポーネントは API コミュニティ内のすべてのアセットを検索するための高度な検索機能を提供します。

テンプレートコミュニティでは、API Catalog (API カタログ) コンポーネントへのリンクが API Carousel (API カルーセル) コンポーネントの下に表示されます。コミュニティの複数のページに複数の API Catalog (API カタログ) インスタンスがある場合、ページを標準化し、可能な限り一貫したインスタンスを配置することをお勧めします。

混乱を防ぐため、API Catalog (API カタログ) コンポーネントはタグではなく最大 5 個の管理カテゴリを使用するように設計されています。

Anypoint Exchange で新しいカテゴリを追加すると、キャッシュが自動的に更新されるときに、5 分以内に API Catalog (API カタログ) 設定にそのカテゴリが表示されます。

少なくとも 1 つの API にそのカテゴリの値がある場合にのみ、API Catalog (API カタログ) 設定にカテゴリが表示されます。

Exchange でカテゴリが削除または変更されると、すべての API Catalog (API カタログ) インスタンスに変更が自動的に反映されます。

カードには、1 つのカテゴリの複数のバッジを使用できます。最大 3 個のバッジを表示可能で、さらにバッジがある場合は、それらを表示するためのツールチップが提供されます。

カテゴリの色を指定しない場合、コミュニティテーマがデフォルトとして使用されます。色は、​#FF0000​ や ​#0000FF​ などの 16 進数値、または ​red​ や ​blue​ などの標準の CSS の色名で指定できます。

URL パラメーターを使用して、検索条件をカタログに渡すことができます。たとえば、カタログコンポーネントを含むページの URL の末尾を ​?catalogFilters=Country:Argentina,USA;Payment:Cash,Credit​ にすることができます。

表示される API アイコン、名前、説明は、​コミュニティに API バージョンを追加​するときに API コミュニティマネージャーのコントロールパネルで設定されます。

API Catalog (API カタログ) コンポーネントの次のパラメーターの値を指定できます。

API コンソールのコンポーネントについての詳細は、​「API Console (API コンソール)」​を参照してください。

API Custom Field Table (API カスタム項目テーブル)​ コンポーネントには、API のすべてのカスタム項目とその値が表示されます。

API Custom Field Table (API カスタム項目テーブル)​ の次のパラメーターの値を指定できます。

デフォルトでは、テーブルには Anypoint 組織にリストされているすべてのカスタム項目が表示されます。一部の項目のみを表示する手順は、次のとおりです。

API Custom Field Pills (API カスタム項目ピル)​ コンポーネントには、最大 5 個の API のカスタム項目とその値が一連の項目と値のペアとして表示されます。

API Custom Field Pills (API カスタム項目ピル)​ の次のパラメーターの値を指定できます。

API Details Button (API の詳細ボタン) コンポーネントは、API に関する詳細をポータルユーザーに提供します。

API Details Button (API の詳細ボタン) の次のパラメーターの値を指定できます。

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

API Documentation Viewer (API ドキュメントビューアー) の次のパラメーターの値を指定できます。

このコンポーネントのマークダウンページに直接リンクするには、URL クエリパラメーター ​selectedPage​ をページ名とまったく同じ名前に設定します。たとえば、ページの名前が「Details」の場合、URL は ​/communityapi/a003D000001pQpjQAE/basicapi?selectedPage=Details​ のようになります。​selectedPage​ がこのコンポーネントのコミュニティビルダーと URL の両方で定義されている場合、コミュニティビルダーの値が使用され、URL の値は無視されます。

API Engagement (API エンゲージメント) コンポーネントは、API に対するいいね! 数やサブスクリプション数を示し、ユーザーが API にいいね! と言ったり、サブスクライブしたりすることができます。

API Engagement (API エンゲージメント) コンポーネントの次のパラメーターの値を指定できます。

API Header (API ヘッダー) コンポーネントは、API ヘッダーにアイコン、名前、連絡先メール、説明などを表示します。

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

API Header (API ヘッダー) の次のパラメーターの値を指定できます。

アセットの複数のバージョンが表示される場合、API Header (API ヘッダー) コンポーネントにはバージョンセレクターが表示され、​[Show API Version (API バージョンを表示)]​ チェックボックスが無効になります。

メール連絡先を表示する手順は、次のとおりです。

Application Analytics Graph (アプリケーション分析グラフ) コンポーネントは、アプリケーションの使用に関する統計情報 (トラフィック、応答時間、アプリケーションの健全性など) を表示します。

このコンポーネントには、​Anypoint API Manager​ からのアプリケーション統計情報が表示されます。

Application Analytics Graph (アプリケーション分析グラフ) の次のパラメーターの値を指定できます。

Application Details (アプリケーション詳細) コンポーネントは、​Anypoint API Manager​ からアプリケーションの詳細を表示します。

このコンポーネントには、アプリケーションの説明、アプリケーション URL、リダイレクト URI、クライアント ID、クライアントシークレット、API および API グループとのアプリケーションのコントラクトが表示されます。

Application Details (アプリケーション詳細) の次のパラメーターの値を指定できます。

Application Listing (アプリケーションリスト) コンポーネントは、API を使用しているアプリケーションのリストを表示します。

API の詳細ページなどのスコープ内の API レコード ID があるページでは、コンポーネントにはその API の現在のバージョンにアクセスできるアプリケーションのみが表示されます。

このコンポーネントには、​Anypoint API Manager​ からのアプリケーションの名前、クライアント ID、およびクライアントシークレットが表示されます。

Application Listing (アプリケーションリスト) の次のパラメーターの値を指定できます。

Instance Viewer (インスタンスビューアー) コンポーネントには、API インスタンス環境、表示ラベル、URL が表示されます。

Instance Viewer (インスタンスビューアー) の次のパラメーターの値を指定できます。

Learn More Button (詳細ボタン) コンポーネントは、API に関する追加情報を含むカスタムページをポータルユーザーに提供します。

Learn More Button (詳細ボタン) の次のパラメーターの値を指定できます。

Login Form (ログインフォーム) コンポーネントは、コミュニティメンバーがポータルにログインできるようにします。

Login Form (ログインフォーム) の次のパラメーターの値を指定できます。

Login Requester (ログイン要求機能) コンポーネントは、API のユーザーフォーラムのフィードバックやディスカッションアクティビティにアクセスするためにはログインする必要があることをゲストユーザーに通知します。

Self Register (セルフ登録) コンポーネントは、ユーザーがポータルアカウントに登録できるようにします。

Self Register (セルフ登録) コンポーネントの次のパラメーターの値を指定できます。

Spec Downloader (仕様ダウンローダー) コンポーネントは、ユーザーが API 仕様をダウンロードできるようにします。

API コミュニティマネージャーからダウンロードした API 仕様は、Anypoint Exchange からダウンロードした仕様と同じです。

使用可能なボタンは、​[Download Spec as RAML (RAML として仕様をダウンロード)]​ および ​[Download Spec as OAS (OAS として仕様をダウンロード)]​ です。

仕様を RAML、OAS 2.0、または OAS 3.0 としてアップロードします。RAML バージョンをアップロードすると、自動的に OAS 2.0 バージョンが生成されます。OAS 2.0 または OAS 3.0 バージョンをアップロードすると、自動的に RAML バージョンが生成されます。RAML と OAS 形式のわずかな違いにより、自動的に生成されたバージョンは、アップロードされたバージョンと若干異なる可能性があります。

Spec Downloader (仕様ダウンローダー) コンポーネントの次のパラメーターの値を指定できます。

User Settings (ユーザー設定) コンポーネントでは、ユーザーが通知設定を定義して、どのメールを受信するか制御できます。

User Subscriptions (ユーザーサブスクリプション) コンポーネントには、ユーザーの API サブスクリプションと、各 API のサブスクライブを解除するオプションが示されます。

API Carousel (API カルーセル) コンポーネントと API Catalog (API カタログ) コンポーネントは ​[Filter Condition (Advanced) (検索条件 (詳細))]​ パラメーターを使用して、​条件​ (Salesforce Object Query Language (SOQL) の標準検索) を満たす API のみを表示します。

条件には次の項目を使用できます。

次の例は検索条件を示しています。

OR​ または ​AND​ を使用するクエリは、条件全体を括弧で囲む必要があります。

API コミュニティマネージャーは、通常の文字列比較を使用してバージョングループを比較します。

SOQL についての詳細は、『Salesforce SOQL および SOSL リファレンス』を参照してください。

API Carousel (API カルーセル) コンポーネントと API Catalog (API カタログ) コンポーネントは ​[Categories Filter (Advanced) (カテゴリ検索条件 (詳細))]​ パラメーターを使用して、Anypoint Exchange で指定した値のカテゴリに属する API のみを表示します。

カテゴリと値は、​Country=Argentina;Payment=Credit​ のようにセミコロン区切りのペアとして記述します。同じカテゴリの複数の値を区切るには、​Country=Argentina,Spain;Payment=Credit​ のようにカンマを使用します。

API Carousel (API カルーセル) または API Catalog (API カタログ) には、カテゴリ検索条件のすべてのカテゴリと値のペア、およびすべての検索条件に一致する API のみが表示されます。