1. Homepage
  2. API コミュニティマネージャー
  3. サイトの操作

  4. API 表示の設定

API 表示の設定

Anypoint API コミュニティマネージャーでは、表示ルールを使用して選択済みのユーザーグループに API が表示されます。

たとえば、コミュニティで金融開発者チームの 3 人のユーザーに支払 API と取引 API を表示し、小売開発者チームの他の 2 人のユーザーには注文送信 API を表示できます。

API 表示ルールは、Salesforce オブジェクト CommunityApi を使用して、コミュニティで公開されている各 API を表します。また、Salesforce の 公開グループと​共有ルールを使用して、柔軟な権限モデルを提供します。

表示設定

API 表示を設定するには、表示を有効にするようにコミュニティを設定し、メンバーグループを定義し、表示ルールを定義して、グループに API を表示する権限を付与します。

表示を有効にする

次の手順に従って、コミュニティの API 表示を設定します。

  1. [Customer Community Plus ユーザー]​ プロファイルに基づいて新しい ​[ACM Community User Plus (ACM コミュニティユーザープラス)]​ プロファイルを作成します。

    1. Salesforce の [設定]​ > ​[プロファイル]​ をクリックします。

    2. [Customer Community Plus ユーザー]​ を選択します。

    3. [コピー]​ をクリックします。

    4. ユースケースを表す新しいプロファイルの名前 (​External Developer​ など) を入力します。

    5. API コミュニティマネージャーのドキュメントセクション​「メンバーユーザープロファイル権限の設定」​で説明されているメンバーユーザープロファイルの権限と一致する権限を割り当てます。

  2. 新しいプロファイルを使用するようにコミュニティを設定します。

    1. [設定]​ > ​[すべてのコミュニティ]​ をクリックします。

    2. API コミュニティマネージャーコントロールパネルで ​[Community Administration (コミュニティ管理)]​ をクリックし、​[メンバー]​ タブをクリックします。

    3. [プロファイルを選択]​ で、検索メニューを使用して ​[顧客]​ を選択します。

    4. 新しい ​[ACM Community User Plus (ACM コミュニティユーザープラス)]​ プロファイルを選択済みのプロファイルに追加します。

    5. 既存の ​[ACM Community User (ACM コミュニティユーザー)]​ プロファイルを削除しますが、​[システム管理者]​ プロファイルは削除​しないでください​。

      [システム管理者]​ プロファイルを削除するとロックアウトされ、コミュニティへのすべてのアクセス権が削除されます。

  3. コミュニティ共有セットからすべてのプロファイルを削除します。

    1. [設定]​ > ​[コミュニティ設定]​ をクリックします。

    2. [共有セット]​ で、コミュニティ共有セットを編集し、​[選択済みプロファイル]​ からすべてのプロファイルを削除します。

    3. 共有セットの ​[選択されたオブジェクト]​ に ​[CommunityApi]​ が含まれている場合は、それを削除します。

  4. コミュニティにすでにユーザーがいる場合は、​[設定]​ > ​[ユーザー]​ をクリックし、各ユーザーを更新して ​[ユーザーライセンス]​ を ​[Customer Community Plus]​ に変更し、新しい ​[ACM Community User Plus (ACM コミュニティユーザープラス)]​ プロファイルを選択します。

  5. API コミュニティマネージャーコントロールパネルで、各 API の表示を ​[Members Only (メンバーのみ)]​ に設定します。

メンバーグループを定義する

公開グループ​とも呼ばれるメンバーグループを使用してメンバーをグループ化し、グループに対して個々の API を表示可能にします。​共有設定​とも呼ばれる表示ルールにより、メンバーグループに表示される API が決まります。

メンバーグループを作成する手順は、次のとおりです。

  1. [設定]​ > ​[公開グループ]​ をクリックします。

  2. 公開グループを作成します。

  3. 名前 (​External Developers​ など) を入力します。

  4. [保存]​ をクリックします。

メンバーグループにメンバーを追加する手順は、次のとおりです。

  1. [設定]​ > ​[公開グループ]​ をクリックします。

  2. グループを編集します。

  3. [検索]​ メニューで、​[カスタマーポータルユーザー]​ を選択します。

  4. [選択可能なユーザー]​ からメンバーを ​[選択済みのユーザー]​ ボックスに移動して追加します。

    [選択可能なユーザー]​ には、新しい ​[ACM Community User Plus (ACM コミュニティユーザープラス)]​ プロファイルを持つユーザーのみが表示されます。追加するユーザーが ​[選択可能なユーザー]​ に含まれていない場合は、ユーザーレコードを開いてプロファイルを確認します。

  5. [保存]​ をクリックします。

API の表示ルールを定義する

共有設定​とも呼ばれる表示ルールを使用して、特定のメンバーグループに表示される API を決定する一連の条件を定義します。

新しい共有セットを作成する手順は、次のとおりです。

  1. [設定]​ > ​[共有設定]​ をクリックします。

  2. [共有設定を管理する対象]​ で、​[CommunityApi]​ を選択します。

  3. [共有ルール]​ で、​[新規]​ をクリックします。

  4. ルールの名前を入力します。

  5. [ルールタイプを選択します]​ で、​[条件に基づく]​ を選択します。

  6. API で使用可能な項目 (​[名前]​ や ​[表示]​ など) を使用して、条件をカスタマイズします。

    [検索条件ロジックを追加]​ を使用して、AND/OR 条件を定義します。

  7. メンバーグループを選択して、これらの条件に一致する API を表示できるようにします。

この例では、内部開発者グループに一般公開されている API といくつかの内部 API が表示されます。

共有設定

メンバーグループにメンバーを追加する

メンバーグループにメンバーを追加する手順は、次のとおりです。

  1. [設定]​ > ​[公開グループ]​ をクリックします。

  2. グループを編集します。

  3. [検索]​ で、​[カスタマーポータルユーザー]​ を選択します。

  4. [選択可能なユーザー]​ からメンバーを ​[選択済みのユーザー]​ ボックスに移動して、グループにメンバーを追加します。

    [選択可能なユーザー]​ には、新しい ​[ACM Community User Plus (ACM コミュニティユーザープラス)]​ プロファイルを持つユーザーのみが表示されます。追加するユーザーが ​[選択可能なユーザー]​ に含まれていない場合は、ユーザーレコードを開いてプロファイルを確認します。

  5. [保存]​ をクリックします。

メンバーグループが API を表示できるようにする

メンバーグループが API を表示できるようにする手順は、次のとおりです。

  1. [設定]​ > ​[共有設定]​ をクリックします。

  2. [共有設定を管理する対象]​ で、​[CommunityApi]​ を選択します。

  3. [共有ルール]​ セクションで、新しいルールを作成するか、既存のルールを編集します。

  4. ルールが API と一致することを確認します。

  5. ルールでメンバーグループが指定されていることを確認します。

自動化

ニーズに最適なオプションを使用して、ユーザーをメンバーグループに自動的に割り当てます。

  • デフォルトのメンバーグループへの各新規ユーザーの追加などの単純な自動化の場合、Salesforce プロセスビルダーを使用します。

  • グループ割り当てのビジネスルールを APEX コードで直接書き込むことによる複雑な自動化の場合、 APEX トリガー​を使用します。

  • 宣言型グループ割り当てを使用した複雑な自動化の場合、Salesforce フローを使用します。