1. Homepage
  2. API コミュニティマネージャー
  3. サイトのブランディングとカスタマイズ

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

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

コミュニティビルダーで Lightning コンポーネントを追加および設定することで、Anypoint API コミュニティマネージャーポータルのページを設計します。

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

各 API コミュニティマネージャー Lightning コンポーネントには異なる設定オプションがあり、異なる機能がポータルに追加されます。

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

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

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

Result Page URL (結果ページ URL)

ユーザーが検索を入力した後に表示される検索結果ページの URL を指定します。

Search Areas (検索領域)

検索するコンテンツのタイプ (​[APIs (API)]​、​[API Groups (API グループ)]​、​[Applications (アプリケーション)]​、​[Knowledge Articles (ナレッジ記事)]​、​[Cases (ケース)]​、​[Discussions (ディスカッション)], ​[Topics (トピック)], ​[Managed Content (CMS) (管理コンテンツ (CMS))], ​[API Specifications (API 仕様)], ​[Documentation Pages (ドキュメントページ)]​、​[Custom Fields (カスタム項目)]​) を選択します。

Number of results to show (表示する結果の数)

ユーザーがクエリを入力するときに表示される結果の数を指定します。

Enable advance links (高度なリンクを有効化)

検索結果が、タブセット ID に基づいて、API の詳細ページの特定のタブ (コンソール、ドキュメント、カスタム項目、アプリケーションなどのタブ) にリンクされるようにします。

[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. ビルダーを開きます。

  2. 認証済みユーザーとしてコミュニティをプレビューします。

  3. API の詳細ページを開きます。

  4. タブを選択します。

  5. 現在のページの URL で、​tabset-1a2b3c=2​ や ​tabset-1a2b3c=4d5e6f​ のようなタブセット ID を見つけます。

  6. このタブセット ID を ​Console Tab Set Id​ などのタブセット ID 項目にコピーします。

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

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

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

ACM Search Results (ACM 検索結果)

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

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

Component Title (コンポーネントタイトル)

結果のタイトルを指定します。

Border (境界線)

境界線の太さを指定します。値は、​[Thick (太)]​、​[Medium (中)]​、​[Thin (細)]​、または ​[None (なし)]​ です。デフォルトは ​[Thin (細)]​ です。

Show Search Input (検索の入力を表示)

結果ページに検索の入力を表示します。

Enable advance links (高度なリンクを有効化)

検索結果が、タブセット ID に基づいて、API の詳細ページの特定のタブ (コンソール、ドキュメント、カスタム項目、アプリケーションなどのタブ) にリンクされるようにします。

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

  1. ビルダーを開きます。

  2. 認証済みユーザーとしてコミュニティをプレビューします。

  3. API の詳細ページを開きます。

  4. タブを選択します。

  5. 現在のページの URL で、​tabset-1a2b3c=2​ や ​tabset-1a2b3c=4d5e6f​ のようなタブセット ID を見つけます。

  6. このタブセット ID を ​Console Tab Set Id​ などのタブセット ID 項目にコピーします。

API Access Requester (API アクセスリクエスター)

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

API を指定します。

Button Border Radius (ボタンの境界線の半径)

ボタンの境界線の半径を選択します。半径が大きいほど、ボタンの丸みが増します。

Button Align (ボタン位置揃え)

左、右、または中央の位置揃えを指定します。

Show Modal Title Line (モーダルタイトル行を表示)

アクセスリクエストモーダルにタイトル行を表示します。

API Card (API カード)

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

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

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

API

表示される API を指定します。

Override URL (URL を上書き)

デフォルトでは、[API Details (API の詳細)] ボタンは API メインページにリンクされます。必要に応じて、ドキュメントやマーケティング資料などの他の情報にユーザーを誘導するように [Override URL (URL を上書き)] を設定できます。

Show Buttons (ボタンを表示)

[API Details (API の詳細)] ボタンを表示します。ボタンが表示されていない場合は、カード上の任意の場所をクリックすることで API の詳細を表示できます。

Card Height (カードの高さ)

カードの高さを指定します。

Card Margin (カードの余白)

カード周囲の余白の量を指定します。

Card Border (カードの境界線)

カードの境界線の太さを指定します。

Card Border Radius (カードの境界線の半径)

カードの境界線の半径を指定します。半径が大きいほど、カードの丸みが増します。

Card Shadow (カードの影)

カードの下に表示する影を指定します。

API Details Button Label (API 詳細ボタン表示ラベル)

API 詳細ボタン表示ラベルを設定できます。デフォルトは ​[API Details (API の詳細)]​ です。

Learn More Button Label (詳細ボタン表示ラベル)

詳細ボタン表示ラベルを設定できます。デフォルトは ​[Learn More (詳細はこちら)]​ です。

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

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

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

Show Buttons (ボタンを表示)

各カード上に [API Details (API の詳細)] ボタンを表示します。ユーザーはボタンが存在する場合はボタンをクリックし、存在しない場合はカードの任意の場所をクリックして、API の詳細を表示できます。

Max Cards Display (最大カード表示数)

表示するカードの最大数を指定します。

Rows (行数)

カルーセル内のカードの行数を指定します。

Show Arrows (矢印を表示)

カルーセルの右端と左端に矢印を表示します。矢印をクリックすると、クリックした矢印の方向にカードがスクロールします。

Arrow Size (矢印のサイズ)

右端と左端の矢印のサイズを指定します。

Show Dots (ドットを表示)

カードの下にドットを表示します。各ドットは、カルーセル内のカードのページにリンクされます。

Card Height (カードの高さ)

カードの高さを指定します。

Card Margin (カードの余白)

各カードの周囲の余白を指定します。

Card Border (カードの境界線)

カードの境界線の太さを指定します。

Card Border Radius (カードの境界線の半径)

カードの境界線の半径を指定します。半径が大きいほど、カードの丸みが増します。

Card Shadow (カードの影)

各カードの下に表示する影を設定します。

Message If Empty (空白時のメッセージ)

カルーセルに API がない場合にメッセージを表示します。デフォルトは ​There are no APIs available right now.​ です。

​Show (表示)

[APIs (API)]​、​[Groups (グループ)]​、​[APIs and Groups (API とグループ)]​、​[Children (子)]​ のいずれを表示するかを指定します。デフォルトは ​[APIs and Groups (API とグループ)]​ です。​[Children (子)]​ には API グループ内の API が表示されます。​[Children (子)]​ 設定は、​[Page Variation (ページのバリエーション)]​ が ​[API Detail (API の詳細)]​ ではなく ​[API Group Detail (API グループの詳細)]​ に設定されているページでのみ使用します。

Filter Condition (Advanced) (検索条件 (詳細))

「​検索条件​」で説明されている構文を使用して指定された検索条件に一致する API のみをカルーセルに表示します。

Categories Filter (Advanced) (カテゴリ検索条件 (詳細))

「​カテゴリ検索条件​」で説明されている構文を使用して指定されたカテゴリに一致する API のみをカルーセルに表示します。

API Details Button Label (API 詳細ボタン表示ラベル)

API 詳細ボタン表示ラベルを設定できます。デフォルトは ​[API Details (API の詳細)]​ です。

Learn More Button Label (詳細ボタン表示ラベル)

詳細ボタン表示ラベルを設定できます。デフォルトは ​[Learn More (詳細はこちら)]​ です。

API Catalog (API カタログ)

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 カタログ) コンポーネントの次のパラメーターの値を指定できます。

Component Title (コンポーネントタイトル)

カタログのタイトルを指定します。デフォルトは ​[API Catalog (API カタログ)]​ です。

Show API Counter (API カウンターを表示)

現在の検索と検索条件に一致する API の数を表示する API カウンターを表示できます。

APIs Per Page (ページあたりの API 数)

カタログの各ページに表示される API の数を指定します。デフォルトは値 12 です。

Category Filter 1 through Category Filter 5 (カテゴリ検索条件 1 ～ カテゴリ検索条件 5)

コミュニティメンバーとゲストユーザーが API を絞り込むために使用できるカテゴリを指定します。デフォルトは ​[None (なし)]​ です。

Category Color 1 through Category Color 5 (カテゴリの色 1 ～ カテゴリの色 5)

各カテゴリの色を指定します。

Search Input Position (検索入力位置)

検索ボックスの位置が検索条件の横か、検索条件の下かつカードの上かを指定します。

Category Card Badge 1 through Category Card Badge 3 (カテゴリカードバッジ 1 ～ カテゴリカードバッジ 3)

カードの上部にバッジとして表示されるカテゴリを指定します。色はカテゴリの色と同じです。

Show (表示)

[APIs (API)]​、​[Groups (グループ)]​、​[APIs and Groups (API とグループ)]​、​[Children (子)]​ のいずれを表示するかを指定します。デフォルトは ​[APIs and Groups (API とグループ)]​ です。​[Children (子)]​ には API グループ内の API が表示されます。​[Children (子)]​ 設定は、​[Page Variation (ページのバリエーション)]​ が ​[API Detail (API の詳細)]​ ではなく ​[API Group Detail (API グループの詳細)]​ に設定されているページでのみ使用します。

Filter Condition (Advanced) (検索条件 (詳細))

「​検索条件​」で説明されている構文を使用して指定された検索条件に一致する API のみをカタログに表示します。

Categories Filter (Advanced) (カテゴリ検索条件 (詳細))

「​カテゴリ検索条件​」で説明されている構文を使用して指定されたカテゴリに一致する API のみをカタログに表示します。

API Console (API コンソール)

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

API Custom Field Table (API カスタム項目テーブル)

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

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

Record Id (レコード ID)

API を指定します。デフォルトは ​{!recordId}​ で、現在のページで選択されている API のインスタンスが表示されます。

Show Table Header​ (テーブルヘッダーを表示)

テーブルヘッダーを表示します。

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

  1. [設定]​ > ​[カスタムメタデータ型]​ > ​[ACM General Configuration Metadata (ACM 一般設定メタデータ)]​ > ​[レコードの管理]​ を開きます。

  2. [ACM Configuration (ACM 設定)]​ の横で、​[編集]​ をクリックします。

  3. [CustomFieldsFilter]​ ボックスで、一連のカスタム項目キーをカンマ区切りリスト (​email,rating,case​ など) として入力します。

    すべてのカスタム項目キーをリストするには、開発者コンソールを開いてクエリ ​SELECT acm_pkg\​TagKey​c FROM acm_pkg\​AnypointCustomFields​x​ を実行します。

API Custom Field Pills (API カスタム項目ピル)

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

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

Record Id (レコード ID)

API を指定します。デフォルトは ​{!recordId}​ で、現在のページで選択されている API のインスタンスが表示されます。

Custom Fields (カスタム項目)

表示する 5 個のカスタム項目を指定します。

API Details Button (API の詳細ボタン)

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

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

API

表示する API を指定します。

Button Label (ボタンの表示ラベル)

ボタンの表示ラベルを指定します。デフォルトは ​[API Details (API の詳細)]​ です。

Button Align (ボタン位置揃え)

UI 項目の左、右、または中央にボタンの位置を揃えます。

API Name (API 参照名)

ボタンの表示ラベルに API 参照名を追加します。値は、​[Append (追加)]​、​[Prepend (先頭に追加)]​、または ​[None (なし)]​ です。デフォルトは ​[None (なし)]​ です。

API Version (API バージョン)

ボタンの表示ラベルに API バージョンを追加します。値は、​[Append (追加)]​、​[Prepend (先頭に追加)]​、または ​[None (なし)]​ です。デフォルトは ​[None (なし)]​ です。

API Documentation Viewer (API ドキュメントビューアー)

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

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

API

API を指定します。

Section (セクション) (省略可能)

開くセクションを選択します。​Selected Page (選択されたページ) (省略可能)​ の設定が空白である場合は、​Section (省略可能)​ の設定は無視されます。

Selected Page (選択されたページ) (省略可能)

開くページを選択します。

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

API Engagement (API エンゲージメント)

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

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

Record Id (レコード ID)

API を指定します。デフォルトは ​{!recordId}​ で、現在のページで選択されている API のインスタンスが表示されます。

API Header (API ヘッダー)

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

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

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

API

表示する API を指定します。

Show "Learn More" Button ([Learn more (詳細はこちら)] ボタンを表示)

[Learn more (詳細はこちら)] ボタンを表示します。

API Learn More Button Label (API の [Learn More (詳細はこちら)] ボタンの表示ラベル)

API のボタンの表示ラベルを指定します。デフォルトは ​[Learn More (詳細はこちら)]​ です。

API Group Learn More Button Label (API グループの [Learn More (詳細はこちら)] ボタンの表示ラベル)

API グループのボタンの表示ラベルを指定します。デフォルトは ​[Learn More about this API Group (この API グループの詳細はこちら)]​ です。

Show API Access Requester (API アクセスリクエスターを表示)

API アクセスリクエスターを表示します。

Show API Version (API バージョンを表示)

1 つのバージョンのみが表示される場合、Exchange からのアセットバージョンを表示します。

Show Contact Email (連絡先メールを表示)

Exchange からの連絡先メールを表示します。

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

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

  1. [設定]​ > ​[カスタムメタデータ型]​ > ​[ACM General Configuration Metadata (ACM 一般設定メタデータ)]​ > ​[レコードの管理]​ を開きます。

  2. [Show Contact Email (連絡先メールを表示)]​ をオンにします。

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

アプリケーション分析グラフ

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

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

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

Application (アプリケーション)

表示するアプリケーションを指定します。

Application Details (アプリケーション詳細)

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

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

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

Application (アプリケーション)

表示する API を指定します。

Enable Application Editing (アプリケーション編集を有効化)

名前や説明などのアプリケーションの詳細を編集できるようにします。

アプリケーション編集が有効になっている場合、コンポーネントには ​[Reset Credentials (ログイン情報をリセット)]​ ボタンが表示されます。デフォルトでは、このボタンはクライアントプロバイダー種別が Anypoint のアプリケーションで機能し、OpenID などの異なるクライアントプロバイダー種別のアプリケーションではエラーが表示されます。管理者はボタンをカスタマイズして、Anypoint 以外のクライアントプロバイダー種別のアプリケーションでログイン情報を正常にリセットできます。

Application Listing (アプリケーションリスト)

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

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

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

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

New Application URL (新規アプリケーション URL)

新しいアプリケーション URL を指定します。

Card Margin (カードの余白)

カード周囲の余白の量を指定します。

Card Border (カードの境界線)

カードの境界線の太さを指定します。

Card Border Radius (カードの境界線の半径)

カードの境界線の半径を指定します。半径が大きいほど、カードの丸みが増します。

Card Shadow (カードの影)

カードの下に表示する影を指定します。

Card Width (カードの幅)

カードの幅を指定します。

Card Height (カードの高さ)

カードの高さを指定します。

Instance Viewer (インスタンスビューアー)

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

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

Record Id (レコード ID)

API を指定します。デフォルトは ​{!recordId}​ で、現在のページで選択されている API のインスタンスが表示されます。

Show Copy URL Icon ([Copy URL (URL をコピー)] アイコンを表示)

[Copy URL (URL をコピー)]​ アイコンを表示します。

Show content in a Box (ボックス内にコンテンツを表示)

インスタンス情報の周囲にボックスを表示します。

Show Production-type environments (本番種別環境を表示)

本番種別環境環境を表示します。

Show Sandbox-type environments (Sandbox 種別環境を表示)

Sandbox 種別環境環境を表示します。

Show Instance Label (インスタンス表示ラベルを表示)

各インスタンスの名前を表示します。

Show table header (テーブルヘッダーを表示)

テーブルヘッダーを表示します。

Advanced Filter (詳細な検索条件)

Salesforce Object Query Language (SOQL) の条件を満たす API のみを表示します。条件では、​Name​、​Environment​、​URL​ 項目を使用できます (例: Name LIKE 'v1%'​)。

Learn More Button (詳細ボタン)

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

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

API

表示する API を指定します。

Button Label (ボタンの表示ラベル)

ボタンの表示ラベルを指定します。デフォルトは、​Learn more about this API​ です。

Button Align (ボタン位置揃え)

UI 項目の左、右、または中央にボタンの位置を揃えます。

API Name (API 参照名)

ボタンの表示ラベルに API 参照名を追加します。値は、​[Append (追加)]​、​[Prepend (先頭に追加)]​、または ​[None (なし)]​ です。デフォルトは ​[None (なし)]​ です。

API Version (API バージョン)

ボタンの表示ラベルに API バージョンを追加します。値は、​[Append (追加)]​、​[Prepend (先頭に追加)]​、または ​[None (なし)]​ です。デフォルトは ​[None (なし)]​ です。

Login Form (ログインフォーム)

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

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

Start URL (開始 URL)

ログイン後にメンバーに表示する URL を指定します。 デフォルト値はポータルのホームページです。

Username Label (ユーザー名表示ラベル)

ユーザー名項目の表示ラベルを指定します。デフォルトは、​Email​ です。

Password Label (パスワード表示ラベル)

パスワード項目の表示ラベルを指定します。デフォルトは、​Password​ です。

Login Button Label (ログインボタン表示ラベル)

ログインボタンの表示ラベルを指定します。デフォルトは、​Log in​ です。

Forgot Password Label (パスワードを忘れた場合の表示ラベル)

パスワードを忘れた場合のリンクの表示ラベルを指定します。デフォルトは、​Forgot your password?​ です。

Forgot Password URL (パスワードを忘れた場合の URL)

パスワードを忘れた場合のリンクの URL を指定します。デフォルトは、​/ForgotPassword​ です。

Self Register Label (セルフ登録表示ラベル)

セルフ登録リンクの表示ラベルを指定します。デフォルトは、​Not a member?​ です。

Self Register URL (セルフ登録 URL)

セルフ登録リンクの URL を指定します。デフォルトは、​/SelfRegister​ です。

Login Requester (ログイン要求機能)

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

Self Register (セルフ登録)

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

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

Start URL (開始 URL)

開始 URL を指定します。デフォルトはポータルのホームページです。

Confirm URL (確認 URL)

確認用の URL を指定します。デフォルトは、​/CheckPasswordResetEmail​ です。

First Name Label (名表示ラベル)

名項目の表示ラベルを指定します。デフォルトは、​First Name​ です。

Last Name Label (姓表示ラベル)

姓項目の表示ラベルを指定します。デフォルトは、​Last Name​ です。

Email Label (メール表示ラベル)

メールアドレス項目の表示ラベルを指定します。デフォルトは、​Email​ です。

Password Label (パスワード表示ラベル)

パスワード項目の表示ラベルを指定します。デフォルトは、​Create Password​ です。

Confirm Password Label (パスワード確認表示ラベル)

パスワード確認項目の表示ラベルを指定します。デフォルトは、​Confirm Password​ です。

Submit Button Label (送信ボタン表示ラベル)

送信ボタンの表示ラベルを指定します。デフォルトは、​Sign Up​ です。

Include Password Field (パスワード項目を含める)

パスワード項目を表示します。

Extra Field Set (追加項目セット)

追加項目を指定します。

Registrations Require Approval (登録に承認が必要)

登録に承認が必要かどうかを選択します。

Approver ID (承認者 ID)

承認者の ID を指定します。

Spec Downloader (仕様ダウンローダー)

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 (仕様ダウンローダー) コンポーネントの次のパラメーターの値を指定できます。

Record Id (レコード ID)

API を指定します。デフォルトは ​{!recordId}​ です。これは、現在のページで選択されている API の仕様をダウンロードします。

Layout (レイアウト)

ボタンのレイアウトを ​[Horizontal (横方向)]​ (デフォルト) または ​[Vertical (縦方向)]​ から指定します。

Buttons Color Picker (ボタンカラーピッカー)

ボタンの色を指定します。

Download Spec Options (仕様オプションをダウンロード)

[Original Format (元の形式)], ​[All (すべて)]​ (デフォルト), ​[OAS3]​、​[RAML]​ を表示するダウンロードボタンを指定します。

Show Export Message (エクスポートメッセージを表示)

エクスポートボタンの横にアイコンを表示し、API 仕様を別のバージョンにエクスポートするときに考えられる不整合について警告するツールチップを表示します。

User Settings (ユーザー設定)

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

User Subscriptions (ユーザーサブスクリプション)

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

検索条件

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

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

  • Icon

  • Name

  • NavigateUrl

  • VersionGroup

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

  • Name = 'My API'​: API 参照名が ​My API​ と完全に等しい。

  • Name LIKE '%My API%'​: API 参照名にテキスト ​My API​ が含まれる。

  • (NOT Name LIKE '%BETA%')​: API 参照名にテキスト ​BETA​ が含まれない。

  • (Name = 'API Alpha' OR Name = 'API Bravo')​: API 参照名が ​API Alpha​ または ​API Bravo​ である。

  • (Name = 'My API' AND VersionGroup = 'v1')​: API 参照名が ​My API​、API バージョングループが ​v1​ である。

  • (Name LIKE 'Product%' OR Name LIKE 'Shipping%' OR Name LIKE 'Order%')​: API 参照名が ​Product​、​Shipping​、または ​Order​ で始まる。

  • Icon != ''​: API にアイコンが含まれる。

  • NavigateUrl != ''​: API に詳細を含むカスタムページにリンクする [Learn More (詳細はこちら)] ボタンが含まれる。

  • VersionGroup = 'v2'​: API バージョングループが ​v2​ と完全に等しい。

  • VersionGroup > 'v1'​: API バージョングループが ​v1​ より後。

  • VersionGroup < 'v1'​: API バージョングループが ​v1​ より前。

  • VersionGroup >= 'v2'​: API バージョングループが ​v2​ 以降。

  • VersionGroup <= 'v2'​: API バージョングループが ​v2​ 以前。

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 のみが表示されます。