# mulesoft Api Experience Hub - Full Documentation # Anypoint Platform で ID プロバイダーが設定されていない場合の SSO の設定 このユースケースには、Anypoint Platform で他の ID プロバイダーが設定されていない場合に、ポータルの ID プロバイダーをセットアップするための手順が含まれています。ID プロバイダーが設定されていないため、デフォルトの ID プロバイダーにより、ポータルの ID プロバイダーが Anypoint Platform の ID プロバイダーに自動的にマップされ、すべての Salesforce ユーザーに Anypoint Platform の ID が提供されます。デフォルトの ID プロバイダーについての詳細は、​[「標準の設定」](https://docs.mulesoft.com/jp/api-experience-hub/enabling-sso-for-your-portal#out-of-the-box-configurations)​を参照してください。 ## [](#始める前に)始める前に - 任意の ID プロバイダーで、アプリケーションにアクセスできるユーザーに対するユーザーまたは ID が存在する必要があります。 - [「始める前に」](https://docs.mulesoft.com/jp/api-experience-hub/%3Cenabling-sso-for-your-portal#before-you-begin >)セクションの情報を確認して、API Experience Hub が ID プロバイダーのカスタムユーザー属性とクレームを設定するために必要なロール、権限、その他の情報を理解します。 ## [](#ステップ-1-ポータルの-sso-を有効にする)ステップ 1 - ポータルの SSO を有効にする SSO を有効にするには、Anypoint Platform で Salesforce ユーザー用の ID を作成するための ID プロバイダーが必要です。 このステップでは、API Experience Hub ポータルの ID プロバイダーでアプリケーションを作成し、アプリケーション設定でグループ情報を送信する機能を有効にし、グループを設定し、デフォルトの ID プロバイダーを設定します。これらの手順を実行するには、アプリケーションと ID プロバイダーアプリケーション間を行き来して情報をコピーまたは追加する必要があります。 ### [](#次のサンプル方法のいずれかを使用してアプリケーションを作成および設定)次のサンプル方法のいずれかを使用してアプリケーションを作成および設定 - Okta OpenID Connect を使用してアプリケーションを作成および設定する - Okta SAML を使用してアプリケーションを作成および設定する #### [](#okta-openid-connect-を使用してアプリケーションを作成および設定する)Okta OpenID Connect を使用してアプリケーションを作成および設定する Details OpenID Connect を使用して ID プロバイダーで API Experience Hub ポータル用の新しいアプリケーションを作成します。 1. Okta で、OpenID Connect Web アプリケーションを作成します。詳細は、 [「Create OIDC app integrations (OIDC アプリケーションインテグレーションの作成)」](https://help.okta.com/oie/en-us/content/topics/apps/apps_app_integration_wizard_oidc.htm)​を参照してください。 2. **\[Connection (一般設定)\]**​ セクションで、次の項目に入力します。
項目 値

App integration name (アプリケーションインテグレーション名)

アプリケーションの名前を入力します。

Grant tpe (許可種別)

[Authorization Code (認証コード)]​ を選択します。

Assignments (割り当て)

[Limit access to selected groups (選択済みのグループへのアクセスを制限)]​ を選択します。

Selected group(s) (選択済みのグループ)

アプリケーションにアクセスする必要があるグループの名前を入力します。

3. ID プロバイダーが、​[「始める前に」](https://docs.mulesoft.com/jp/api-experience-hub/enabling-sso-for-your-portal#before-you-begin)​セクションにリストされた予期されるクレームを送信していることを確認します。 4. アプリケーションが送信するクレームを設定します。 たとえば、Okta 用の OpenID Connect の場合、次の手順を使用してグループクレームを設定します。 1. **\[Sign On (サインオン)\]**​ タブで、​**\[OpenID Connect ID Token (OpenID Connect ID トークン)\]**​ セクションの ​**\[Edit (編集)\]**​ をクリックします。 2. **\[Groups claim type (グループクレーム種別)\]**​ で、​**\[Filter (検索条件)\]**​ を選択します。 3. **\[Groups claim filter (グループクレーム検索条件)\]**​ で、​`[groups (グループ)]`​ を入力します。 4. 式で ​**\[Matches regex\]**​ を選択し、ワイルドカードに​`「.*」`​を入力します。 ![グループクレーム検索条件の例](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-groups-claim-filter.png) 5. OpenID Connect を使用して、Salesforce の認証プロバイダーを設定します。 ID プロバイダーアプリケーション情報を使用して、Salesforce で認証プロバイダーまたは SSO 設定をセットアップします。 1. OpenID Connect アプリケーションから、次の設定値を取得します。 - **Client ID (クライアント ID)** - **Client Secret (クライアントシークレット)** - **Authorize Endpoint URL (承認エンドポイント URL)** - **Token Endpoint URL (トークンエンドポイント URL)** - **User Info Endpoint URL (ユーザー情報 エンドポイント URL)** 2. **Salesforce**​ で ​**\[設定\]**​ に移動します。 3. **\[クイック検索\]**​ ボックスに​`「認証」`​と入力し、​**\[認証プロバイダー\]**​ を選択します。 4. **\[新規\]**​ をクリックします。 5. **\[プロバイダータイプ\]**​ で、​**\[OpenID Connect\]**​ を選択します。 6. 次の項目に入力します。
項目 値

プロバイダータイプ

OpenID Connect​

名前

プロバイダーの名前を入力します。

コンシューマーキー

ID プロバイダーのクライアント ID を入力します。

コンシューマーの秘密

ID プロバイダーのクライアントシークレットを入力します。

Authorize Endpoint URL (承認エンドポイント URL)

Token Endpoint URL (トークンエンドポイント URL)

User Info Endpoint URL (ユーザー情報 エンドポイント URL)

デフォルトのスコープ​

profile openid email groups (プロファイルの openid メールグループ)​

登録ハンドラー​

AEHPortalRegistrationHandler​

他のアカウントで登録を実行​

システム管理者ユーザーを選択します。

![Salesforce 認証プロバイダーの例](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-salesforce-auth-provider.png) 7. **\[保存\]**​ をクリックします。 6. ポータルのリダイレクト URI を設定します。 リダイレクトを設定するには、15 桁の組織 ID と 18 桁の組織 ID を使用し、各組織 ID の URL を追加します。 1. Okta アプリケーションで、​**\[General (一般)\]**​ タブを選択します。 **\[Sign-in redirect URIs (サインインリダイレクト URI)\]**​ に次の URL を追加します。 - [https://login.salesforce.com/services/authcallback/${15DigitSalesforceOrganizationId}/${authProviderURLSuffix}](https://login.salesforce.com/services/authcallback/${15DigitSalesforceOrganizationId}/${authProviderURLSuffix}) - [https://login.salesforce.com/services/authcallback/${18DigitSalesforceOrganizationId}/${authProviderURLSuffix}](https://login.salesforce.com/services/authcallback/${18DigitSalesforceOrganizationId}/${authProviderURLSuffix}) - [https://${domain}.my.site.com/aeh/services/authcallback/${authProviderURLSuffix}](https://${domain}.my.site.com/aeh/services/authcallback/${authProviderURLSuffix}) ![リダイレクト URI の例](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-sso-redirect-uris.png) URL を見つける手順は、次のとおりです。 - salesforceOrganizationId の場合、​**\[設定\]**​ > ​**\[組織情報\]**​ に移動する。 - authProviderURLSuffix の場合、​**\[設定\] > \[認証プロバイダー\]**​ に移動し、認証プロバイダーをクリックして ​**\[URL 接尾辞\]**​ を選択する。 - domain の場合、​**\[設定\]**​ > \[私のドメイン\] > ​**\[現在の \[私のドメイン\] の URL\]**​ に移動する。 #### [](#okta-saml-を使用してアプリケーションを作成および設定する)Okta SAML を使用してアプリケーションを作成および設定する Details SAML を使用して ID プロバイダーで API Experience Hub ポータル用の新しいアプリケーションを作成します。詳細は、Okta ドキュメントの [「Create SAML app integrations (SAML アプリケーションインテグレーションの作成)」](https://help.okta.com/oie/en-us/content/topics/apps/apps_app_integration_wizard_saml.htm)​を参照してください。 1. Okta から、SAML アプリケーションを作成します。 2. **\[General Settings (一般設定)\]**​ に SAML アプリケーションの名前を入力します。 3. **\[Do not display application icon to users (ユーザーにアプリケーションアイコンを表示しない)\]**​ を選択します。 4. **\[Next (次へ)\]**​ をクリックします。 5. **\[SAML Settings (SAML 設定)\]**​ で、次の項目に入力します。
項目 値

Single Sign-On URL (シングルサインオン URL)

ポータルログインの URL を入力します。

Use this for Recipient URL and Destination URL (これを受信 URL と宛先 URL に使用)

このオプションを選択します。

Audience URI (SP Entity ID) (オーディエンス URI (SP エンティティ ID))

https と Salesforce ドメイン (https://{salesforcedomain}.com など) を入力します。

Name ID format (名前 ID 形式)

EmailAddress

Application username (アプリケーションユーザー名)

Okta username (Okta ユーザー名)

Update application username on (アプリケーションユーザー名の更新タイミング)

Create and update (作成および更新)

![SAML 設定の例](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-sso-saml-settings.png) 6. ID プロバイダーでユーザーを適切にマップするために API Experience Hub がクレームに期待する内容については、​[「始める前に」](https://docs.mulesoft.com/jp/api-experience-hub/enabling-sso-for-your-portal#before-you-begin)​セクションを参照してください。 7. **\[Attribute Statements (optional) (属性ステートメント (省略可能))\]**​ セクションで、次のカスタム属性を追加して SAML インテグレーションを設定します。サポートされる形式については、​[「カスタムユーザー属性」](https://docs.mulesoft.com/jp/api-experience-hub/enabling-sso-for-your-portal#custom-user-attributes)​を参照してください。
名前 名前形式 値

first_name

Unspecified

user.firstName

last_name

Unspecified

user.lastName

email

Unspecified

user.email

groups

Unspecified

(",", getFilteredGroups({"00gdkat3p5RCvkQQC5d7", "00gdjgk337kYDxtE35d7"}, "group.name", 40))

![SAML 属性ステートメントの例](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-sso-saml-attribute-statements.png) この例の ID の 00gdkat3p5RCvkQQC5d7 と 00gdjgk337kYDxtE35d7 は、送信するグループに対応します。Anypoint Platform で Okta を設定する場合は、必ずすべての Anypoint Platform グループを送信してください。そうしないと、ユーザーがアクセスできなくなる可能性があります。 8. **\[Next (次へ)\]**​ をクリックします。 9. **\[I’m an Okta customer adding an internal app (私は内部アプリケーションを追加する Okta ユーザーです)\]**​ を選択します。 10. **\[Finish (完了)\]**​ をクリックします。 11. **\[Assignments (割り当て)\]**​ タブを選択して ​**\[Groups (グループ)\]**​ を選択します。 12. **\[Assign (割り当て)\]**​ をクリックし、​**\[Assign to groups (グループに割り当て)\]**​ を選択します。 13. リストから、特定のグループの行の ​**\[Assign (割り当て)\]**​ をクリックし、​**\[Done (完了)\]**​ をクリックします。 14. **\[Sign On (サインオン)\]**​ タブを選択し、​**\[View SAML setup instructions (SAML セットアップ手順を表示)\]**​ をクリックして、アプリケーションに SAML を設定する方法の手順を表示します。 ![\[View SAML setup instructions (SAML セットアップ手順を表示)\] ボタン](_images/aeh-sso-view-saml-setup-instructions.png) 15. Salesforce の ​**\[シングルサインオン設定\]**​ タブを設定するには、手順ページから次の情報を取得します。 - **Identity Provider Single Sign-On URL (ID プロバイダーシングルサインオン URL)** - **Identity Provider Issuer (ID プロバイダー発行者)** - **X.509 Certificate (X.509 証明書) (証明書をダウンロード)** ![ページをセットアップする SAML 手順](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-sso-saml-setup-instructions-page.png) 16. **Salesforce**​ の ​**\[設定\]**​ に移動し、​**\[シングルサインオン設定\]**​ を検索します。 17. **\[シングルサインオン設定\]**​ タブの ​**\[SAML を使用した統合シングルサインオン\]**​ セクションで、​**\[SAML を有効化\]**​ を選択し、​**\[保存\]**​ をクリックします。 18. **\[シングルサインオン設定\]**​ タブで ​**\[編集\]**​ をクリックし、次の項目に入力します
項目 値

Issuer (発行者)

[View SAML setup instructions (SAML セットアップ手順を表示)]​ の ​[Identity Provider Issuer (ID プロバイダー発行者)]​ に合わせます。

Entity ID (エンティティ ID)

アプリケーションで設定した​オーディエンス制限​に合わせます。

ID プロバイダーの証明書

[View SAML setup instructions (SAML セットアップ手順を表示)]​ から以前にダウンロードした証明書をアップロードします。

SAML ID 種別

アサーションには、ユーザーオブジェクトの​統合 ID​ が含まれます。

SAML ID の場所

ID は、​Subject​ ステートメントの ​NameIdentified​ 要素にあります。

ID プロバイダーのログイン URL

[View SAML setup instructions (SAML セットアップ手順を表示)]​ の ​[Identity Provider Single Sign-On URL (ID プロバイダーシングルサインオン URL)]​ に合わせます。

カスタムログアウト URL

Okta の URL

ユーザープロビジョニング

Enabled

ユーザープロビジョニングのタイプ

Apex ハンドラーを使用したカスタム SAML JIT

SAML JIT ハンドラー

AEHPortalRegistrationHandler

他のアカウントでハンドラーを実行

[システム管理者] を選択。

![SAML シングルサインオン設定の例](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-sso-saml-single-sign-on-settings.png) ## [](#add-identity-provider)ステップ 2: Salesforce ID プロバイダーを追加する ID プロバイダーを Salesforce 用に設定したら、API Experience Hub UI からその ID プロバイダーを追加して有効にします。ID プロバイダーが有効になっている場合、ユーザーはこの ID プロバイダーを使用してポータルにログインできます。 1. **\[API Experience Hub\]**​ > ​**\[User management (ユーザー管理)\]**​ に移動します。 2. **\[User management (ユーザー管理)\]**​ ページで、​**\[Login settings (ログイン設定)\]**​ タブを選択します。 3. **\[Single sign-on (SSO) (シングルサインオン (SSO))\]**​ セクションから、ステップ 2 ​**\[Add Salesforce identity providers (Salesforce ID プロバイダーを追加)\]**​ までスクロールダウンします。 4. **\[Select identity provider (ID プロバイダーを選択)\]**​ をクリックし、ドロップダウンメニューからオプションを選択します。 5. **\[+ Add identity provider (+ ID プロバイダーを追加)\]**​ をクリックします。 6. スライダーを ​**\[Enabled (有効)\]**​ に移動します。 ## [](#add-group-mapping)ステップ 3: グループマッピングを追加する ポータルの SSO を設定する場合、ユーザーは Salesforce と Anypoint Platform の両方で ID を持っている必要があります。SSO ユーザーは、グループ名を使用してチームにマップされます。アクセス管理を使用して、ユーザーをチームにマップする必要があります。API Experience Hub には、​**\[AEH Portal (AEH ポータル) - ${salesforceOrganizationId}\_${salesforceCommunityId}\]**​ という標準のチームが用意されており、アクセス管理のチームとして自動的に追加されています。 API Experience Hub で対応するプロファイルにユーザーを追加することで、グループマッピングを追加します。 1. **\[Access Management (アクセス管理)\]**​ > ​**\[Teams (チーム)\]**​ に移動します。 2. **\[AEH Portal Guests (AEH ポータルゲスト)\]**​ を選択し、​**\[AEH Portal Members (AEH ポータルメンバー)\]**​ を選択します。 3. **\[External IdP Groups (外部 IdP グループ)\]**​ を選択します。 4. **\[Group Name (グループ名)\]**​ 項目に​**「AEH Members」**​ (AEH メンバー) と入力します。 5. **\[Provider Name (プロバイダー名)\]**​ 項目で、対応する Salesforce ID プロバイダーの名前を選択します。 6. **\[Type (種別)\]**​ 項目で ​**\[Member (メンバー)\]**​ を選択し、​**\[Add (追加)\]**​ をクリックします。 ![アクセス管理グループマッピング](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-sso-access-mgmt-ext-idp-groups.png) 7. **\[Save Changes (変更を保存)\]**​ をクリックします。 指定したグループに関連付けられている SSO ユーザーがチームに割り当てられます。 ## [](#test-sso)ステップ 4: SSO 設定をテストする ポータルの SSO が正しく設定されていることを確認します。 1. ブラウザーでシークレットウィンドウを開きます。 2. API Experience Hub ポータルに移動します。 3. 設定した SSO オプションを選択します。 4. ポータルの ID プロバイダーで設定したグループに属するユーザーでログインします。 5. ポータルでのユーザーの API の表示を確認します。 6. **\[Access Management (アクセス管理)\]**​ > ​**\[Users (ユーザー)\]**​ に移動します。 7. ユーザー名を使用して検索し、ユーザーが目的の ID プロバイダーにマップされていることを確認します。 8. グループマッピングが設定されているチームに移動します。 **\[Members (メンバー)\]**​ タブで、そこにユーザーが表示されていることを確認します。 ## [](#関連情報)関連情報 - [シングルサインオンエラーのトラブルシューティング](https://docs.mulesoft.com/jp/api-experience-hub/troubleshoot-sso-errors) - [ポータルでのシングルサインオンの有効化](https://docs.mulesoft.com/jp/api-experience-hub/enabling-sso-for-your-portal) - [ユーザーの管理](https://docs.mulesoft.com/jp/api-experience-hub/managing-users) # API Console の使用 API Console は、REST API とそのメソッドに関する情報を表示し、要求を送信してメソッドをテストできる対話型コンポーネントです。API Console は \[API Details (API 詳細)\] ページにあります。エンドポイントはアルファベット順に表示されます。 API Console には、オンボーディングプロセスや適応性にとって重要な API の仕様とドキュメントの情報が表示されます。開発者は API の使用法と統合方法を知っておくと役立ちます。 \[Specification (仕様)\] ペインには REST API の REST 仕様の HTTP 関数のナビゲーションが表示されます。リソースやメソッドを確認することで、出力の形式や構造を理解できます。 \[Documentation (ドキュメント)\] ペインには API に関する対話型のドキュメントが表示されます。API ドキュメントには、各 API バージョンの詳細な説明が含まれます。このドキュメントは、API リリースサイクルで更新され、通常は開発チームが更新に深く関与します。要求の情報や応答を確認することもできます。 \[Try it (試す)\] ペインでは、モッキングサービスまたは API インスタンス URL を使用して REST API をテストできます。モッキングサービスを使用すると、要求と応答を処理する実際のサーバーを使用せずに、API 仕様で定義されたエンドポイントをテストできます。モッキングサービスでは、シミュレーションデータを API 関数に追加し、そのデータを使用して API をテストできます。すべての応答はサンプルデータです。API インスタンスを使用すると、サーバーと対話し、実際の要求と応答の実際のデータを取得できるようになります。 ## [](#api-仕様とドキュメントを確認する)API 仕様とドキュメントを確認する API に関する情報を見つける手順は、次のとおりです。 1. **\[Home (ホーム)\]**​ または ​**\[APIs (API)\]**​ ページで、API を選択します。 2. **\[API specification (API 仕様)\]**​ タブを選択します。 3. **\[Specification (仕様)\]**​ ペインで、関数をクリックします。 4. **\[Documentation (ドキュメント)\]**​ ペインで、関数の概要を確認します。 5. **\[Requests (要求)\]**​ タブを選択して、コード例、パラメーター、セキュリティ、ヘッダー、例、本文に関する情報を表示します。 6. **\[Responses (応答)\]**​ タブを選択して、応答種別、例、ヘッダー、本文を表示します。 ## [](#api-をテストする)API をテストする シミュレーションデータが必要な場合は、モッキングサービスを使用して API 仕様をテストできます。API のインスタンスを使用して、実際のデータで API 仕様をテストすることもできます。インスタンスに認証ヘッダーがある場合、認証ヘッダーが入力されていないと要求は失敗します。 API のテストについての詳細は、次のトピックを参照してください。 - [モッキングサービスを使用したコールのシミュレーション](https://docs.mulesoft.com/jp/api-experience-hub/simulating-api-calls-using-the-mocking-service) - [API インスタンスを使用した API のテスト](https://docs.mulesoft.com/jp/api-experience-hub/testing-apis-using-an-api-instance) # 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 は英語のみのカスタムコンポーネントをサポートしています。 API Experience Hub コンポーネントを追加する手順は、次のとおりです。 1. **\[コンポーネント\]**​ 稲妻アイコンをクリックして、コンポーネントパレットを表示します。 2. 任意のコンポーネントをコンポーネントパレットから現在のページにドラッグします。 3. ページ内のコンポーネントを選択すると、そのコンポーネントの設定オプションが表示されます。 4. コンポーネントのプロパティ項目に値を入力するか値を選択して、値を編集します。 コンポーネントを削除するには、削除アイコンをクリックして、ダイアログで ​**\[Delete (削除)\]**​ をクリックします。 ## [](#api-console)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 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-バージョンの状態)Version State (バージョンの状態) API バージョンのライフサイクル状態が表示されます。 - Asset Documentation Viewer (アセットドキュメントビューアー) API Documentation Viewer (API ドキュメントビューアー) コンポーネントは、Anypoint Exchange からの API のドキュメントを表示します。ドキュメントは複数のページで構成され、各ページは複数のセクションで構成されることもあります。 ## [](#assets-carousel-アセットカルーセル)Assets Carousel (アセットカルーセル) API Carousel (API カルーセル) コンポーネントは、​**\[Home (ホーム)\]**​ ページに表示される水平方向にスクロール可能な API カードのセットを表示します。各カードには、API が表示されます。 次の Assets Carousel (アセットカルーセル) のプロパティの値を指定できます。 - Title (タイトル) カルーセルのタイトル。 - Subtitle (サブタイトル) カルーセルのタイトルの後に表示されるサブタイトル。 - Cards to display (表示するカード数) カルーセルに表示する API カードの数。カルーセルには、最低 3 個、最大 15 個のカードを表示できます。表示するカードの数が 5 で、ポータルに API が 3 つしかない場合、カルーセルには 5 個ではなく 3 個のカードが表示されます。 ### [](#api-carousel-api-カルーセル-のタイトルを変更する)API Carousel (API カルーセル) のタイトルを変更する API Carousel (API カルーセル) に表示されるタイトルとサブタイトルを変更できます。​**\[Subtitle (サブタイトル)\]**​ 項目に ​`{numberOfAssets}`​ 変数を入力して、サブタイトルにカードの数を表示することもできます。例: **Latest APIs added {numberOfAssets} (追加された最新の API 数 {numberOfAssets})**​。次の画像は、変数には ​**\[Cards to display (表示するカード数)\]**​ 項目で選択された番号が表示されるため、サブタイトルに​**「Latest APIs added 5 (追加された最新の API 数 5)」**​と表示されています。 ![Assets Carousel (アセットカルーセル) \[Subtitle (サブタイトル)\] オプションの画像](_images/aeh-builder-carousel-subtitle.png) 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 Carousel (API カルーセル) に表示するカードの数を変更する 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-アセットカタログ)Assets Catalog (アセットカタログ) API Catalog (API カタログ) コンポーネントは、API Portal で使用可能なすべての API を探索する対話的な方法を API コンシューマーに提供します。API Carousel (API カルーセル) には、ページに分割された行と列に API カード、および表示する API をタイプと検索語で絞り込むコントロールが表示されます。各カードには、API が表示されます。カタログを使用すると、ユーザーは多数の API バージョンを表示して探索できます。 ## [](#search-box-検索ボックス)Search Box (検索ボックス) API Experience Hub の Search Box (検索ボックス) コンポーネントを使用すると、ユーザーは Salesforce Experience Cloud に存在するコンテンツ (ナレッジ記事、サポートケース、お知らせなど) および Anypoint Platform に存在するコンテンツ (API やクライアントアプリケーションなど) の両方を検索できます。ナレッジ記事、サポートケース、お知らせは現在使用できません。 ## [](#search-results-検索結果)Search Results (検索結果) API Experience Hub の Search Results (検索結果) コンポーネントは、Search Box (検索ボックス) コンポーネントにユーザーが検索を入力した後の結果を表示します。 ## [](#関連情報)関連情報 - [エクスペリエンスビルダー](https://help.salesforce.com/s/articleView?id=sf.community_designer_overview.htm&type=5) - [Anypoint Exchange](https://docs.mulesoft.com/exchange/) # API Experience Hub Release Notes API Experience Hub is an API management platform and digital experience that enables organizations to create vibrant API ecosystems within and outside the enterprise. API providers can share, promote, and engage with their developer community. Developers and partners can find, explore, and consume APIs designed anywhere from a single place. The following release notes are provided for API Experience Hub: - [Anypoint API Experience Hub Release Notes](https://docs.mulesoft.com/jp/release-notes/api-experience-hub/api-experience-hub-release-notes) ## [](#see-also)See Also - [API Experience Hub の概要](https://docs.mulesoft.com/jp/api-experience-hub/) - [Known Issues](https://help.salesforce.com/s/issues) # API Experience Hub での API バージョン設定 テキストの変更など、API 仕様に互換性を破らない変更が必要になった場合、これらの変更はパッチバージョン変更として行われます (例: バージョン ​`3.0.0`​ からバージョン ​`3.0.1`​)。API Experience Hub は、これらの更新を自動的に、API がパブリッシュされているすべてのポータルに直ちにインポートします。API Experience Hub ポータル管理者によるアクションは不要です。 ## [](#api-バージョンに対するメジャー更新)API バージョンに対するメジャー更新 現在のバージョンとの互換性がない API の新バージョンが作成されたら、API Experience Hub ポータル管理者は、新しいバージョンをサイトでパブリッシュするタイミングと方法をコントロールします。新しいバージョンは表示なしで API エディションモーダルに表示され、コミュニティでは誰もこの API 情報にアクセスできません。管理者は古い API バージョンと新しい API バージョンに対する表示を設定できます。 たとえば、API チームの開発者が API に新しいリソースを追加したとします。 1. 開発者は、Design Center で API を開いて、仕様にリソースを追加してから ​**\[Publish to Exchange (Exchange にパブリッシュ)\]**​ をクリックします。 2. この変更は互換性を破るため、開発者は \[Publish API specification to Exchange (Exchange に API 仕様をパブリッシュ)\] の \[API version (API バージョン)\] 情報を変更します。 たとえば、\[API version (API バージョン)\] が v3 であれば、v4 に変更します。\[Asset version (アセットバージョン)\] が 3.0.1 であれば、4.0.0 に変更します。\[Name (名前)\] と \[Main file (メインファイル)\] は変更しません。 3. 開発者は ​**\[Publish (パブリッシュ)\]**​ をクリックします。 4. 以前の API バージョンは、パブリッシュされているすべてのポータルにそのまま残ります。 ポータル管理者は、変更内容を確認してパブリッシュする必要があります。 1. API Experience Hub で、\[API Management (API 管理)\] に移動します。 API は引き続き ​**\[APIs in the portal (ポータルの API)\]**​ に表示されます。新しいバージョンの表示は \[None (なし)\] になります。 2. API 名の横にあるその他のオプションアイコンをクリックします。 3. 表示を ​**\[Administrators only (管理者のみ)\]**​ に変更します。 4. **\[Preview in Salesforce Builder (Salesforce ビルダーでプレビュー)\]**​ をクリックして API を確認します。 5. \[API Management (API 管理)\] に移動します。 6. API 名の横にあるその他のオプションアイコンをクリックします。 7. 新しいバージョンの表示を変更します。 新しいバージョンを誰にでも公開する場合は ​**\[Administrators only (管理者のみ)\]**​ を ​**\[Everyone (全員)\]**​ に変更し、ログインしたメンバーにのみ表示する場合は \[Members only (メンバーのみ)\] に変更します。 表示が \[Everyone (全員)\] または \[Members only (メンバーのみ)\] である場合、コンシューマー開発者は、新しい API バージョンをポータルの API Carousel (API カルーセル) で表示できるようになります。 # API Experience Hub の使用開始 必要なアカウント、アクセス権、セットアップがあることを確認してから、API Experience Hub の使用を開始します。 ## [](#始める前に)始める前に 次の必要なアカウントとアクセス権があることを確認してください。 - 本番環境の Anypoint Platform 組織 - Salesforce 組織 - メイン組織の組織のシステム管理者 - システム管理者プロファイルを持っているか、リンクプロセス中に接続先となる Salesforce 組織に割り当てられた ​AEH\_A​nypoint 権限セットを持つ Salesforce ユーザーである必要があります。詳細は、[権限の割り当て](https://docs.mulesoft.com/jp/api-experience-hub/assigning-permissions)を参照してください。 API Portal を作成するプロセスには、Salesforce Experience Cloud と接続して Anypoint Platform 組織を Salesforce 組織にリンクすることが含まれます。 - API Experience Hub ライセンス - 2000 以上の外部 ID ライセンス 現在のパッケージには 100 以上の API アクセス権の要求があり、2000 以上の外部 ID ライセンスが必要です。 組織を設定するには、次の Salesforce エディションを使用できます。 - Unlimited Edition - Enterprise Edition - Salesforce の Performance Edition 必要なアカウントとアクセス権がない場合、API Portal 作成時の Salesforce リンクプロセス中に問題が発生する場合があります。 ## [](#api-experience-hub-の使用を開始する)API Experience Hub の使用を開始する 次のユーザーは以下のタスクを開始できます。 **管理者**​: 管理者は、次の簡単な手順で API Portal を作成できます。 1. [権限を割り当てる](https://docs.mulesoft.com/jp/api-experience-hub/assigning-permissions) 管理者が Salesforce に接続してポータルを作成するために必要な権限を設定します。 2. [Salesforce に接続する](https://docs.mulesoft.com/jp/api-experience-hub/connecting-to-salesforce) インスタンスとしては新規または既存の Salesforce 組織を使用できます。接続するには、環境種別を指定してカスタム Salesforce ドメインを入力 (ある場合) し、権限を許可してアカウントを確認します。 3. [ポータルをセットアップしてスタイル設定する](https://docs.mulesoft.com/jp/api-experience-hub/setting-up-the-api-portal) Salesforce に接続したら、ロゴ、フォント、配色などを使用してポータルの標準のページをスタイル設定します。 4. [ポータルを管理する](https://docs.mulesoft.com/jp/api-experience-hub/managing-your-portal) Exchange から API を追加して API バージョンの表示を設定することで API を管理します。ゲストユーザーからのアクセス権の要求を承認することでユーザーを管理します。 5. [ポータルをプレビューしてパブリッシュする](https://docs.mulesoft.com/jp/api-experience-hub/previewing-and-publishing-your-portal)​ ポータルをパブリッシュしてコミュニティが使用できるようにします。 **開発者**​: 開発者は次のタスクを使用して API を検出してコンシュームできます。 1. [ポータルにアクセスするために登録する](https://docs.mulesoft.com/jp/api-experience-hub/registering-for-access-to-portal) 2. [API を検索する](https://docs.mulesoft.com/jp/api-experience-hub/searching-for-apis) 3. [\[API Details (API 詳細)](https://docs.mulesoft.com/jp/api-experience-hub/viewing-api-details) ページを表示する\] 4. [API インスタンスへのアクセス権を要求する](https://docs.mulesoft.com/jp/api-experience-hub/requesting-access-to-an-api-instance) 5. [API とのコントラクトを保持するアプリケーションを表示する](https://docs.mulesoft.com/jp/api-experience-hub/my-applications) 6. [API 仕様をダウンロードする](https://docs.mulesoft.com/jp/api-experience-hub/downloading-an-api-specification) 7. [API Console の仕様とドキュメントを調べる](https://docs.mulesoft.com/jp/api-experience-hub/using-the-api-console) ## [](#関連情報)関連情報 - [ユーザーロール、権限、およびプロファイル](https://docs.mulesoft.com/jp/api-experience-hub/user-roles-permissions-and-profiles) - [ライセンス](https://docs.mulesoft.com/jp/api-experience-hub/licensing) - [Salesforce への接続](https://docs.mulesoft.com/jp/api-experience-hub/connecting-to-salesforce) # API Experience Hub の概要 Anypoint API Experience Hub は API 管理プラットフォームおよびデジタルエクスペリエンスであり、組織はエンタープライズ内外で活気のある API エコシステムを形成できます。 API プロバイダーは開発者コミュニティと共有やプロモートを行い、交流することができます。開発者やパートナーは 1 つの場所から、どこで設計された API であっても見つけて探索し、コンシュームできます。 API Experience Hub は、API Portal の作成や管理を目的とした API コミュニティマネージャーの次世代の進化形です。ポータル管理者は標準のテンプレートを使用して分単位で開発者ポータルを構築し、Anypoint Exchange からどのオーディエンスにも API をパブリッシュできます。Anypoint Platform によって、ポータルのデプロイメント、管理、API およびユーザー管理のオプションが十分に管理されるため、Salesforce に関する知識がなくても使用を開始できます。 API Experience Hub には、次の利点があります。 **ポータル管理者**​: - すばやく簡単にポータルをセットアップできる - API や設定バージョンの表示をオンボーディングできる - ユーザー、およびゲストユーザーからのアクセス権の要求を管理できる - プレビューしてポータルで反復処理を行うことができる - Salesforce エクスペリエンスビルダーを使用して高度なカスタマイズを実行できる - Chatter フィード追跡を有効にしてポータルコミュニティと交流できる - Google アナリティクスを使用して、コンシューマーが API とポータルをどのように使用しているかについて貴重なインサイトを得ることができる **開発者**​: - セルフサービス環境を使用して API を検出してアプリケーションを構築できる - クライアントアプリケーションを登録するために API インスタンスへのアクセス権を要求できる - 対話型の API ドキュメントを使用して API の使用法と統合方法を理解できる - カスタマイズ済みの接続されたハブを使用して API を操作できる - ポータルコミュニティのメンバーとコラボレーションできる API Experience Hub 製品スポットライト動画を視聴して概要を確認できる。 ![](https://play.vidyard.com/T4bQEfxC74Qg3k92wRgt7b.jpg) ## [](#ポータルを作成する手順)ポータルを作成する手順 管理者は、次の手順でカスタムポータルを作成できます。 1. Salesforce インスタンスに接続します。 インスタンスとしては新規または既存の Salesforce 組織を使用できます。接続するには、環境種別を指定してカスタム Salesforce ドメインを入力 (ある場合) し、権限を許可してアカウントを確認します。 2. API Portal をセットアップします。 Salesforce に接続したら、ポータルのセットアップ方法を選択し、ロゴ、フォント、配色などを使用してポータルの標準のページをスタイル設定します。 3. ポータルを管理します。 Exchange から API を追加して API バージョンの表示を設定することで API を管理します。ゲストユーザーからのアクセス権の要求を承認することでユーザーを管理します。 4. ポータルをパブリッシュします。 ポータルをパブリッシュしてコミュニティが使用できるようにします。 ## [](#ポータルページ)ポータルページ 各 API Experience Hub ポータルにはホームページ、API ページ、API の詳細ページが含まれます。ポータル管理者は組織のニーズに合わせて各ページをカスタマイズできます。詳細は、[API Portal のセットアップ](https://docs.mulesoft.com/jp/api-experience-hub/setting-up-the-api-portal)を参照してください。 次のサンプルポータルにはホームページが表示されています。 ![ポータルのホームページ](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-home-page.png) ポータルには次のテンプレートページが含まれます。 - ホーム ホームページにはバナー画像、API Portal タイトル、API Carousel (API カルーセル)、タイプ別の API へのナビゲーションが含まれており、API Portal のランディングページとなります。API Carousel (API カルーセル) では、API コンシューマーは最近ポータルに追加された API をプレビューできます。各カードには API 名、アイコン、タイプ、説明が含まれます。選択すると、開発者は API に関するすべての情報を \[API Details (API 詳細)\] ページで参照できます。 - APIs (API) API ページには、ポータルのすべての API のカタログが含まれます。開発者はカタログを検索して絞り込むことができます。選択すると、カタログの各カードに \[API Details (API 詳細)\] ページが表示されます。 - API Details (API 詳細) \[API Details (API 詳細)\] ページには、名前、説明、タイプ、バージョン、ライフサイクル状態、API の連絡先のメールアドレスなど、API に関するメタデータが表示されます。詳細ページには、概要と API ドキュメントが含まれます。API 概要パネルでは、Anypoint Exchange の API の管理者が作成した概要ページが反映されます。API ドキュメントパネルには、開発者が API ドキュメントを読んで API テストするための対話型のコンソールが含まれます。開発者は、API 仕様で定義された概要、メソッド、エンドポイント、認証の各セクションを読むことができます。 ## [](#製品の統合)製品の統合 API Experience Hub は、次の製品と統合されています。 - Anypoint Exchange Exchange は、再利用可能なアセット (API、ポリシー、API 仕様フラグメント、API グループ、テンプレート、サンプル、カスタムアセット、コネクタなどのインテグレーションアセット) のカタログです。API Experience Hub 内で、ポータル管理者は Exchange から API をインポートすることでポータルを選定できます。詳細は、 [「Anypoint Exchange」](https://docs.mulesoft.com/exchange/)​を参照してください。 - Salesforce Experience Cloud API Experience Hub は Salesforce Experience Cloud を活用しており、開発者オーディエンスにカスタマイズとブランド設定の機能が提供されます。詳細は、​[「エクスペリエンスビルダーを使用したポータルのカスタマイズ」](https://docs.mulesoft.com/jp/api-experience-hub/customizing-your-portal)​を参照してください。 ## [](#サポートされるブラウザー)サポートされるブラウザー サポートされるブラウザーについては、次のトピックを参照してください。 - [Anypoint Platform のブラウザーサポート](https://docs.mulesoft.com/jp/general/browser-support) - [Experience Cloud サイトでサポートされるブラウザー](https://help.salesforce.com/s/articleView?id=sf.networks_communities_browser_support.htm&type=5) ## [](#関連情報)関連情報 - [ユーザーロール、権限、およびプロファイル](https://docs.mulesoft.com/jp/api-experience-hub/user-roles-permissions-and-profiles) - [API Experience Hub の使用開始](https://docs.mulesoft.com/jp/api-experience-hub/getting-started-with-api-experience-hub) # API Portal コミュニティでのコラボレーション Salesforce Chatter フィードコンポーネントを使用して、API Portal コミュニティのメンバーとのコラボレーションを有効にし、次のことを行うことができます。 - 投稿と更新情報を共有する - 投票に参加する - 質問する - パーソナライズされたフィードで関連アクティビティの通知を受け取る 表示される Chatter フィードオプションは、管理者が API Portal のフィードを設定した方法によって異なります。 API に関するフィードバックとディスカッションを表示する手順は、次のとおりです。 1. ポータルの ​**\[Home (ホーム)\]**​ ページまたは ​**\[API\]**​ ページから API を選択します。 2. **\[API details (API 詳細)\]**​ ページで、​**\[Feedback and discussions (フィードバックとディスカッション)\]**​ タブを選択します。 デフォルトのタブ名は​**「Feedback and discussions (フィードバックとディスカッション)」**​ですが、管理者はこの名前を変更できます。 Chatter フィード追跡の使用についての詳細は、次の Salesforce ドキュメントを参照してください。 - [Chatter の概要](https://help.salesforce.com/s/articleView?id=sf.collab_overview.htm&type=5) - [Chatter タブの概要](https://help.salesforce.com/s/articleView?id=sf.collab_home_overview.htm&type=5) - [投稿の概要](https://help.salesforce.com/s/articleView?id=sf.collab_feed_posting.htm&type=5) - [フィードの使用](https://help.salesforce.com/s/articleView?id=sf.collab_feeds_parent.htm&type=5) # API Portal のセットアップ Salesforce 組織に接続したら、ポータル管理者はガイド付きセットアップに従い、標準テンプレートを使用してポータルのセットアッププロセス (ポータルの作成やスタイル設定など) を実行できます。 新規ポータルを作成したり、既存のポータルを使用して新規ポータルを作成したり、後でポータルを作成したりできます。新規ポータルを作成するオプションでは、Salesforce 組織から切断された既存のポータルが使用されます。新規ポータルは、既存のポータルのスタイル設定メタデータを使用します。ガイド付きセットアップからこのオプションを選択すると、スタイル設定プロセスを経由することなく、ポータルをすばやくセットアップできます。ポータルごとに設定できる Salesforce 組織は 1 つのみであるため、既存のポータルはその Salesforce 組織の新規ポータルで上書きされます。 ガイド付き設計には、ホームページ、\[API Catalog (API カタログ)\] ページ、\[API Details (API 詳細)\] ページの基本的なスタイル設定オプションと、ポータルを視覚化するのに役立つライブプレビューが含まれます。各ページには、ポータル設計プロセスのどの段階にいるかが表示される進行状況バーが含まれます。 API Portal のスタイル設定には次のタスクが含まれます。 1. ホームページをスタイル設定する ホームページは API Portal のランディングページであり、API Carousel (API カルーセル) とも呼ばれます。テンプレートにはロゴの追加、バナー画像、組織のブランディング、バナータイトル、ポータルの説明、フッター設定が含まれます。 2. API カタログのスタイル設定 \[APIs (API)\] ページにはポータルの API のコレクションが含まれ、API Catalog (API カタログ) とも呼ばれます。テンプレートには REST や HTTP など、各 API タイプの色のカスタマイズが含まれます。 3. \[API Details (API 詳細)\] ページのスタイル設定 \[API Details (API 詳細)\] ページには、API に関する情報が表示されます。テンプレートには名前、API のタイプ、オーナーのメールアドレス、API の説明が含まれます。 ## [](#api-portal-をセットアップする)API Portal をセットアップする ポータルの作成方法を選択して、API Portal をセットアップします。 1. ガイド付きセットアップの ​**\[Set up API portal (API Portal のセットアップ)\]**​ ページから、ポータルを作成するオプションを選択します。 1. 新しいポータルを作成するには、​**\[Create new portal (新規ポータルを作成)\]**​ をクリックします。 2. 既存のポータルのスタイル設定の選択内容を使用して新規ポータルを作成するには、​**\[Use existing portal (既存のポータルを使用)\]**​ をクリックし、​**\[Override and create new portal (上書きして新規ポータルを作成)\]**​ をクリックします。 3. 後でポータルを作成するには、​**\[Set up portal later (後でポータルをセットアップ)\]**​ をクリックします。 ## [](#ポータルをスタイル設定する)ポータルをスタイル設定する ガイド付き設計に従って ​**\[Next (次へ)\]**​ をクリックして手順を進めます。
ページを更新するか、ガイド付き設計を終了すると、ガイド付きセットアップの進行状況が保持されません。もう一度すべての手順を実行する必要があります。
## [](#始める前に)始める前に ポータルをスタイル設定する前に、以下が必要です。 - 会社ロゴの画像 - ポータルの配色 - 会社のブランディング用のフォント - ポータルのヘッダーとして使用する画像 ## [](#api-portal-のホームページをスタイル設定する)API Portal のホームページをスタイル設定する ガイド付き手順に従ってホームページをスタイル設定します。 1. 会社ロゴを追加するには、画像ファイルを ​**\[Upload company logo (会社ロゴをアップロード)\]**​ にドラッグまたはアップロードします。 サポートされるファイル形式は PNG、JPEG、SVG、GIF です。 2. バナー画像を追加するには、画像ファイルを ​**\[Select banner image (バナー画像を選択)\]**​ にドラッグまたはアップロードします。 サポートされるファイル形式は PNG、JPEG、SVG、GIF です。 3. フォントと色を使用して組織をブランド設定するには、​**\[Customize org branding (組織のブランディングをカスタマイズ)\]**​ で次の作業を行います。 - ドロップダウンメニューからフォントのスタイルを選択します。 - カラーピッカーからバナー画像のフォントの色を選択します。 - カラーピッカーからページの背景色を選択します。 4. ポータルバナーのタイトルを追加するには、​**\[Enter portal banner title (ポータルバナータイトルを入力)\]**​ テキストボックスにタイトルを入力します。 5. API Portal の説明を追加するには、​**\[Enter portal description (ポータルの説明を入力)\]**​ テキストボックスに説明を入力します。 6. フッターテキストと URL を追加するには、​**\[Configure footer (フッターを設定)\]**​ の対応するテキストボックスにフッターテキストと URL を入力します。 7. **\[Next (次へ)\]**​ をクリックして API カタログをスタイル設定します。 ## [](#api-catalog-api-カタログ-をスタイル設定する)API Catalog (API カタログ) をスタイル設定する ガイド付き手順に従って API Catalog (API カタログ) をスタイル設定します。 1. 特定の API の色をカスタマイズするには、​**\[Customize colors (色をカスタマイズ)\]**​ の対応する API タイプのカラーピッカーから色を選択します。 2. API Catalog (API カタログ) のバナータイトルを追加するには、​**\[Enter API catalog banner title (API カタログのバナータイトルを入力)\]**​ テキストボックスにタイトルを入力します。 3. API Catalog (API カタログ) の説明を追加するには、​**\[Enter API catalog description (API カタログの説明を入力)\]**​ テキストボックスに説明を入力します。 4. **\[Next (次へ)\]**​ をクリックして \[API Details (API 詳細)\] ページをスタイル設定します。 ## [](#api-details-api-詳細-をスタイル設定する)\[API Details (API 詳細)\] をスタイル設定する ガイド付き手順に従って \[API Details (API 詳細)\] ページをスタイル設定します。 1. API オーナーのメールアドレスを表示するには、​**\[Customize API Information (API の情報をカスタマイズ)\]**​ から ​**\[API Contact (API 連絡先)\]**​ を有効にします。 2. \[API details (API 詳細)\] ページに API クライアントアプリケーションを表示するには、​**\[Customize API Information (API の情報をカスタマイズ)\]**​ から ​**\[API Clients (API クライアント)\]**​ を有効にします。 3. \[API Details (API 詳細)\] ページにバナータイトルを追加するには、​**\[Enter API detail banner Title (API 詳細のバナータイトルを入力)\]**​ テキストボックスにタイトルを入力します。 4. \[API Details (API 詳細)\] ページの説明を追加するには、​**\[Enter API detail description (API 詳細の説明を入力)\]**​ テキストボックスに説明を入力します。 5. ポータルのスタイル設定を完了していない場合は、​**\[Previous (前へ)\]**​ をクリックして前のページのスタイル設定を変更します。 6. ポータルのスタイル設定を完了している場合は、​**\[Save changes (変更を保存)\]**​ をクリックします。 スタイルを保存してポータルを作成するプロセスには、数分かかる場合があります。いつでもページから離れることができます。 ## [](#デフォルト設定)デフォルト設定 次の設定は、ポータルを作成したときにデフォルトで設定されます。 - ゲストユーザーのセルフ登録はデフォルトで有効になります。 - ポータルの状況は有効になります。 ## [](#次のステップ)次のステップ これでポータルが作成されたため、​[\[Manage your portal (ポータルを管理)](https://docs.mulesoft.com/jp/api-experience-hub/managing-your-portal)\]​ ページから API をポータルに追加して管理し、ユーザーを管理して、設定情報を表示し、ポータルを切断できるようになりました。 ## [](#関連情報)関連情報 - [ポータルの管理](https://docs.mulesoft.com/jp/api-experience-hub/managing-your-portal) - [トラブルシューティング](https://docs.mulesoft.com/jp/api-experience-hub/troubleshooting) # API Portal の作成 API Portal を作成するプロセスには、次の手順が含まれます。 1. [Salesforce に接続する](https://docs.mulesoft.com/jp/api-experience-hub/connecting-to-salesforce) Salesforce に接続して、Anypoint 組織を Salesforce 組織にリンクします。 2. [API Portal をセットアップする](https://docs.mulesoft.com/jp/api-experience-hub/setting-up-the-api-portal) ガイド付きセットアップを使用してポータルをセットアップし、スタイル設定オプションを適用してポータルをブランド設定します。セットアップとスタイル設定が完了すると、ポータルが作成されます。 ## [](#始める前に)始める前に ポータルを作成する前に、次の情報を用意しておくことをお勧めします。 - [「前提条件」](https://docs.mulesoft.com/jp/api-experience-hub/getting-started-with-api-experience-hub)​の確認 - 会社ロゴの画像 - ポータルをスタイル設定するための配色 - ポータルのヘッダーとして使用する画像 # API Portal へのアクセス ポータル管理者がセルフ登録を有効にしている場合、ユーザーはサインアップして API Portal へのアクセス権を取得できます。 次に、ポータルの例を示します。 登録プロセスには、次の手順が含まれます。 1. ブラウザーウィンドウにポータルの URL を入力します。 2. 名、姓、メールアドレスを入力します。 3. **\[Sign Up (サインアップ)\]**​ をクリックします。 セルフ登録はすべて自動的に承認されます。ポータルへのリンクが信頼済みの関係者しかアクセスできないことを確認します。 4. ポータルで、​**\[Log in (ログイン)\]**​ をクリックしてユーザー名とパスワードを入力します。 # API インスタンスへのアクセス権の要求 メンバーユーザーは \[API Details (API 詳細)\] ページで、クライアントアプリケーションを登録する API インスタンスへのアクセス権を要求します。メンバーユーザーはそのために、API インスタンスを選択して、クライアントアプリケーションを選択または作成し、必要に応じてサービスレベル契約 (SLA) を選択します。インスタンスのオーナーが要求を承認すると、クライアントアプリケーションとインスタンス間のコントラクトが作成され、クライアントアプリケーションが登録されます。 クライアント ID 適用ポリシーによって保護されるインスタンスでは、クライアントアプリケーションはクライアント ID とクライアントシークレット (省略可能) を提供する必要があります。アクセス権の要求が承認されると、クライアントアプリケーションが登録され、クライアント ID とクライアントシークレットのログイン情報が自動的に作成されます。メンバーユーザーはポータルでパブリッシュされた API のインスタンスへのアクセス権を要求できます。これらのユーザーは新しいアプリケーションを作成することも、すでに作成済みのアプリケーションを使用してアクセス権を要求することもできます。 アセットに契約条件が設定されている場合、アクセス権が付与される前に契約条件に同意するように求められます。作成されたコントラクトにはこの契約条件が含まれます。 ## [](#始める前に)始める前に API へのアクセス権を要求する前に、メンバーユーザーになって API Portal にログインしている必要があります。​[「ポータルにアクセスするための登録」](https://docs.mulesoft.com/jp/api-experience-hub/registering-for-access-to-portal)​を参照してください。 ## [](#既存のアプリケーションを使用して-api-へのアクセス権を要求する)既存のアプリケーションを使用して API へのアクセス権を要求する 既存のアプリケーションを使用して API へのアクセス権を要求できます。 1. API をクリックして \[API Details (API 詳細)\] ページを開きます。 2. **\[Request access (アクセス権の要求)\]**​ をクリックします。 3. \[API instance (API インスタンス)\] リストで、インスタンスを選択します。 4. **\[Client application (クライアントアプリケーション)\]**​ リストで、アプリケーションを選択します。 アプリケーションとそのインスタンスは同じクライアントプロバイダーを使用します。組織のシステム管理者が Anypoint API Manager で複数のクライアントプロバイダーを設定してある場合、アプリケーションのリストには、選択したインスタンスと同じクライアントプロバイダーを使用しているアプリケーションのみが表示されます。 5. **\[SLA tier (SLA 層)\]**​ で、アプリケーションのサービスレベル契約 (SLA) の値を選択します。 \[SLA tier (SLA 層)\] は、インスタンスに 1 つ以上の層がある場合のみ表示されます。 6. API に契約条件がある場合、​**\[I accept the terms and conditions (契約条件に同意します)\]**​ を選択します。 7. **\[Request access (アクセス権の要求)\]**​ をクリックします。 \[Request access (アクセス権の要求)\] メッセージが表示され、要求が受信され、保留中であることが通知されます。SLA 層に自動承認がある場合は、メッセージでアクセス権の要求が承認されたことが表示され、アプリケーションが \[My Applications (マイアプリケーション)\] ページに表示されます。 8. **\[Okay (OK)\]**​ をクリックして、メッセージを閉じます。 SLA 層に自動承認がある場合、アプリケーションが受信され、承認されます。 9. **\[Okay (OK)\]**​ をクリックして、メッセージを閉じます。 10. アプリケーション詳細を確認するには、​**\[My Applications (マイアプリケーション)\]**​ ページに移動します。 \[My Applications (マイアプリケーション)\] ページには、このアクセスインスタンスのクライアント ID とクライアントシークレットが表示されます。 ## [](#新しいアプリケーションを作成して-api-へのアクセス権を要求する)新しいアプリケーションを作成して API へのアクセス権を要求する アクセス権を要求するために使用するアプリケーションがない場合は、新しいアプリケーションを作成します。 1. \[API Catalog (API カタログ)\] で、API をクリックして \[API Details (API 詳細)\] ページを開きます。 2. **\[Request access (アクセス権の要求)\]**​ をクリックします。 3. **\[API instance (API インスタンス)\]**​ リストで、インスタンスを選択します。 4. **\[Client application (クライアントアプリケーション)\]**​ オプションで、​**\[Create a new application (新しいアプリケーションを作成)\]**​ を選択します。 5. **\[Name (名前)\]**​ 項目に、クライアントアプリケーション名を入力します。 6. **\[Description (説明)\]**​ 項目に、クライアントアプリケーションの説明を入力します。 7. **\[OAuth 2.0 Grant Type (OAuth 2.0 許可種別)\]**​ オプションで、アプリケーションの許可種別がある場合は、許可種別を選択します。 8. **\[OAuth 2.0 Redirect URIs (OAuth 2.0 リダイレクト URI)\]**​ 項目に、リダイレクト元 URI アドレスを入力します。 9. **\[Application URL (アプリケーション URL)\]**​ 項目に、URL を入力します。 10. **\[SLA tier (SLA 層)\]**​ オプションで、アプリケーションのサービスレベル契約 (SLA) の値を選択します。 11. **\[Request access (アクセス権の要求)\]**​ をクリックします。 SLA 層で自動承認が有効になっている場合、アプリケーションが承認されたというメッセージが表示されます。自動承認が有効になっていない場合、要求が保留中であるというメッセージが表示されます。 12. **\[Okay (OK)\]**​ をクリックして、メッセージを閉じます。 アプリケーションが承認されると、メールが送信されます。 13. **\[Okay (OK)\]**​ をクリックして、メッセージを閉じます。 14. アプリケーション詳細を確認するには、ポータルから ​**\[My Applications (マイアプリケーション)\]**​ ページに移動します。 \[My Applications (マイアプリケーション)\] ページには、このアクセスインスタンスのクライアント ID とクライアントシークレットが表示されます。 ## [](#関連情報)関連情報 - [API 詳細の表示](https://docs.mulesoft.com/jp/api-experience-hub/viewing-api-details) - [My Applications (マイアプリケーション)](https://docs.mulesoft.com/jp/api-experience-hub/my-applications) # API インスタンスを使用した API のテスト API Console では、API インスタンスをサーバーとして使用して API をテストできます。API インスタンスを使用すると、要求を送信し、実際のデータを含む応答を取得することで、サーバーと対話できます。 ## [](#始める前に)始める前に 1 つ以上のエンドポイントと 1 つのメソッドが含まれる API 仕様が必要です。 ## [](#インスタンスを使用して-api-をテストする)インスタンスを使用して API をテストする 1. **\[Home (ホーム)\]**​ または ​**\[APIs (API)\]**​ ページで、REST API を選択します。 2. **\[API specification (API 仕様)\]**​ タブを選択します。 3. **\[Specification (仕様)\]**​ ペインで、​`get`​ などのメソッドをクリックします。 4. **\[Try it (試す)\]**​ ペインで、​**\[Select Server (サーバーの選択)\]**​ オプションからインスタンス URL を選択します。 5. テストするクエリパラメーターを入力します。 6. **\[Send (送信)\]**​ をクリックしてデータを API に送信します。 7. API から返された応答を確認します。 # API の検出 ポータルのホームページまたはランディングページには、API Carousel (API カルーセル) があります。API Carousel (API カルーセル) は、使用可能なすべての API を探索する対話的な方法を API コンシューマーに提供します。API Carousel (API カルーセル) には、ページに分割された行と列に API カード、および表示する API をタイプと検索語で絞り込むコントロールが表示されます。各カードには、API が表示されます。カルーセルを使用すると、多数の API バージョンを表示して探索できます。 API ページには、ポータルのすべての API の API Catalog (API カタログ) があります。検索可能なカタログは、水平方向にスクロール可能な API カードのセットを表示します。各カードには、API が表示されます。API アイコン、名前、説明は Exchange からの API 情報に基づいて表示されます。 ## [](#関連情報)関連情報 - [API の検索](https://docs.mulesoft.com/jp/api-experience-hub/searching-for-apis) - [API 詳細の表示](https://docs.mulesoft.com/jp/api-experience-hub/viewing-api-details) # API の検出とコンシューム 開発者やパートナーはセルフサービス API Portal を使用して、アプリケーションにすばやくアクセスし、ドキュメントを操作して、既存のデータから製品を構築できます。開発者は API Experience Hub ポータルを使用して、製品の構築に必要不可欠な API を検索、コンシューム、再利用できます。 詳細は、次のトピックを参照してください。 - [ポータルにアクセスするための登録](https://docs.mulesoft.com/jp/api-experience-hub/registering-for-access-to-portal) - [API の検出](https://docs.mulesoft.com/jp/api-experience-hub/discovering-apis) - [API の検索](https://docs.mulesoft.com/jp/api-experience-hub/searching-for-apis) - [API 詳細の表示](https://docs.mulesoft.com/jp/api-experience-hub/viewing-api-details) - [API インスタンスへのアクセス権の要求](https://docs.mulesoft.com/jp/api-experience-hub/requesting-access-to-an-api-instance) - [My Applications (マイアプリケーション)](https://docs.mulesoft.com/jp/api-experience-hub/my-applications) - [API 仕様のダウンロード](https://docs.mulesoft.com/jp/api-experience-hub/downloading-an-api-specification) - [API Console の使用](https://docs.mulesoft.com/jp/api-experience-hub/using-the-api-console) # API の検索 \[APIs (API)\] ページから、API 名でカタログを検索して特定の API を見つけます。​**\[Search by API name (API 名で検索)\]**​ 項目に 4 文字以上を入力し、​**\[Search Results (検索結果)\]**​ ページからオプションを選択します。 ![\[Search by API name (API 名で検索)\] 検索ボックス](_images/aeh-search-by-api-name-box.png) タイプで API を絞り込み、検索結果をさらに絞り込むことができます。検索条件オプションは、ポータルで使用可能な API タイプ (REST、HTTP、SOAP、Async など) に応じて表示されます。 ![任意のタイプで絞り込み](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-filter-by-type.png) ホームページでは、任意の API タイプカードをクリックしてカルーセルを絞り込むこともできます。 ![API タイプで絞り込み](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-api-type-filter.png) ## [](#関連情報)関連情報 - [API 詳細の表示](https://docs.mulesoft.com/jp/api-experience-hub/viewing-api-details) # API の管理 **\[API Management (API 管理)\]**​ ページで、Exchange からの API に関する情報を表示して、API の追加または削除を行い、API バージョンの表示を変更することで、ポータルを選定します。 ポータルでは、次の API 種別がサポートされます。 - AsyncAPI - HTTP - REST - SOAP **\[API Management (API 管理)\]**​ ページには、次の情報が表示されます。 - **APIs in the portal (ポータルの API)**​ ポータルに追加されている API が表示されます。管理者が追加できるのは、「Exchange Viewer (Exchange 閲覧者)」権限を持つ API のみです。詳細は、[権限の割り当て](https://docs.mulesoft.com/jp/api-experience-hub/assigning-permissions)を参照してください。 すべてのシステム管理者には、ポータルに追加されたすべての API に対する「Exchange Viewer (Exchange 閲覧者)」権限が自動的に割り当てられます。デフォルトでは、API の表示は \[Administrators (管理者)\] に設定されています。ポータル管理者は、​**\[APIs in the portal (ポータルの API)\]**​ タブで API の表示設定を変更したり、API を削除したりできます。 \+ ポータルでは最大 350 個の API を使用できます。 - **APIs in Exchange (Exchange の API)** Exchange 組織に存在するが、ポータルにはまだ追加されていない API が表示されます。 ## [](#exchange-での-api-の表示)Exchange での API の表示 Exchange から直接 API に関する情報を表示して、ポータルで API を追加するかどうかを判断できます。 **\[APIs in Exchange (Exchange の API)\]**​ タブで、リストから API を選択し、その他のオプションアイコンをクリックして、​**\[View in Exchange (Exchange で表示)\]**​ を選択します。 ## [](#exchange-から-api-を追加する)Exchange から API を追加する Exchange から API を追加することで、API Experience Hub でポータルを選定します。API をポータルに追加するには、Exchange に API が必要です。ポータルに API を追加する場合、デフォルトの表示は \[Administrators (管理者)\] です。メンバーまたは全員が含まれるように表示を変更できます。詳細は、​[「API バージョンを表示する」](#make-api-versions-visible)​を参照してください。 ポータルに API を追加する手順は、次のとおりです。 1. **\[API management (API 管理)\]**​ ページで、​**\[APIs in Exchange (Exchange の API)\]**​ タブを選択します。 2. 名前または説明で API を検索するには、​**\[Search (検索)\]**​ バーに名前または説明を入力します。 3. リストで API を見つけて、​**\[+\] (ポータルに追加)**​ をクリックします。 API は ​**\[APIs in the portal (ポータルの API)\]**​ タブのリストに表示されます。 ## [](#ポータルから-api-を削除する)ポータルから API を削除する ポータルから API を削除する手順は、次のとおりです。 1. **\[API management (API 管理)\]**​ ページで、​**\[APIs in the portal (ポータルの API)\]**​ タブを選択します。 2. API を検索するには、名前、説明、カテゴリ、またはタグキーワードを ​**\[Search (検索)\]**​ ボックスに入力します。 3. リストで API を見つけて、ゴミ箱 (ポータルから削除) をクリックします。 4. **\[Confirm (確認)\]**​ をクリックします。 **\[APIs in the portal (ポータルの API)\]**​ タブで、API がリストから削除されます。 ## [](#api-バージョンを表示する)API バージョンを表示する デフォルトでは、新しい API を追加すると、管理者と共有されているマイナーバージョンが最新バージョンの API になります。API インスタンスの表示は \[Public (公開)\] インスタンスに設定されます。エンドユーザーがアクセス権を要求できるのは、Exchange でパブリッシュされている API インスタンスのみです。 ユーザーがポータルで表示できる API のバージョンを管理できます。表示は \[Administrators (管理者)\]、\[Members (メンバー)\] およびユーザーグループ、\[Guests (ゲスト)\]、または \[None (なし)\] に設定できます。 - Administrators (管理者) このオプションは、バージョンをポータル管理者のみに表示する場合に使用します。 - Members (メンバー) このオプションは、バージョンをログイン済みのメンバーまたは特定のユーザーグループのみに表示する場合に使用します。 - Guests (ゲスト) このオプションは、バージョンを公開して誰にでも表示する場合に使用します。 - なし 全員にバージョンを非表示にするには、ユーザーなしを選択します。 表示が \[Guests (ゲスト)\]、\[Members (メンバー)\]、またはユーザーグループである場合、コンシューマー開発者は、新しい API バージョンをポータルの API Carousel (API カルーセル) で表示できます。 API について表示されるユーザーの表示を編集する手順は、次のとおりです。 1. **\[API management (API 管理)\]**​ ページで、​**\[APIs in Portal (ポータルの API)\]**​ を選択します。 2. API を検索するには、名前、説明、カテゴリ、またはタグキーワードを ​**\[Search (検索)\]**​ ボックスに入力します。 3. リストで API を見つけて、​**\[Edit visibility (表示を編集)\]**​ をクリックします。 4. API インスタンスオプションを選択します。 - All instances (すべてのインスタンス) - エンドユーザーは API へのアクセスを要求できません。 - Public instances (公開インスタンス) - エンドユーザーが API へのアクセスを要求できます。 5. API バージョンを展開し、API を表示できるユーザーを選択します。 6. **\[Save (保存)\]**​ をクリックします。 ## [](#次のステップ)次のステップ [\[User Management (ユーザー管理)](https://docs.mulesoft.com/jp/api-experience-hub/managing-users)\]​ から、ユーザーと、ゲストユーザーからのアクセス権の要求を表示して管理できます。 # API 仕様のダウンロード API 仕様のコピーは、​**\[Download (ダウンロード)\]**​ をクリックして \[API Details (API 詳細)\] ページからダウンロードできます。 ダウンロードファイル種別は API に応じて異なります。 - REST API RAML \[As RAML (RAML として)\] を選択した場合、元の RAML ファイルが zip ファイルとしてダウンロードされます。\[As OAS (OAS として)\] を選択した場合、API 仕様は OAS 2.0 形式の仕様の JSON ファイルが含まれる zip ファイルとしてダウンロードされます。 - REST API OAS \[As RAML (RAML として)\] を選択した場合、API 仕様はその仕様の RAML ファイルが含まれる zip ファイルとしてダウンロードされます。\[As OAS (OAS として)\] を選択した場合、元の JSON 形式または YAML 形式のファイルが含まれる zip ファイルがダウンロードされます。 - SOAP API WSDL WSDL ファイルとしてダウンロードされます。 ## [](#関連情報)関連情報 - [API Console の使用](https://docs.mulesoft.com/jp/api-experience-hub/using-the-api-console) - [モッキングサービスを使用した API コールのシミュレーション](https://docs.mulesoft.com/jp/api-experience-hub/simulating-api-calls-using-the-mocking-service) - [API インスタンスを使用した API のテスト](https://docs.mulesoft.com/jp/api-experience-hub/testing-apis-using-an-api-instance) # API 表示の詳細の編集 API について表示される次の情報を編集できます。 - 説明 - API インスタンスの表示 - API バージョンの表示 - API アイコン画像 画像ファイルは .png である必要があります。 API について表示される情報を編集する手順は、次のとおりです。 1. \[API Catalog (API カタログ)\] で、API カードをクリックします。 \[API Management(API 管理)\] ページに API の情報が表示されます。 2. **\[Actions (アクション)\]**​ オプションから ​**\[Edit display details (表示の詳細を編集)\]**​ を選択します。 3. 説明を変更するには、新しいアセットの説明を ​**\[Description (説明)\]**​ 項目に入力します。 4. API インスタンスの表示を変更するには、ドロップダウンリストからオプションを選択します。 5. API バージョンの表示を変更するには、対応するバージョンのドロップダウンリストからオプションを選択します。 6. API アイコンを変更するには、​**\[Upload file (ファイルをアップロード)\]**​ をクリックして承認済みの画像ファイル種別を選択します。 7. 変更をキャンセルするには、​**\[Cancel (キャンセル)\]**​ をクリックします。 8. 変更を保存するには、​**\[Save (保存)\]**​ をクリックします。 # API 詳細の表示 \[API Details (API 詳細)\] ページを表示するには、ポータルのホームページまたは \[APIs (API)\] ページから API を選択します。 \[API Details (API 詳細)\] ページには、API に関する次の情報が表示されます。 - **Name (名前)** API の名前。 - **Type (種別)** API 種別は、AsyncAPI、HTML、REST、または SOAP です。 - **Contact email (連絡先メール)** API の連絡先のメール。 - **Categories (カテゴリ)** この API が属する定義済みカテゴリの名前と値。API には複数のカテゴリを設定できます。カテゴリは API をグループに編成し、参照と検出を改善します。カテゴリは Exchange で作成および管理されます。 - **Tags (タグ)** この API に関連付けられた定義済みキーワードの名前。API には複数のタグを設定できます。タグは Exchange で作成および管理されます。 - **Description (説明)** API の説明。 - **Asset version (アセットバージョン)** API のバージョン。 - **Version state (バージョンの状態)** この API のライフサイクル状態 (開発、安定、または非推奨)。 - **Instances (インスタンス)** API のインスタンスの数。 - **Clients (クライアント)** 各 API のクライアントアプリケーションの数。 API Console は \[API Details (API 詳細)\] ページにあります。このコンソールコンポーネントは対話型であり、API 仕様とそのメソッドに関する情報が表示されます。エンドポイントはアルファベット順に表示されます。詳細は、​[「API Console の使用」](https://docs.mulesoft.com/jp/api-experience-hub/using-the-api-console)​を参照してください。 ## [](#カテゴリとタグを表示する)カテゴリとタグを表示する API のカテゴリまたはタグを表示する手順は、次のとおりです。 1. **\[API Details (API 詳細)\]**​ ページで、​**\[Categories (カテゴリ)\]**​ または ​**\[Tags (タグ)\]**​ をクリックして情報を表示します。 2. **\[Categories (カテゴリ)\]**​ または ​**\[Tags (タグ)\]**​ を再度クリックして、リストを閉じます。 ## [](#インスタンス情報を表示して-url-をコピーする)インスタンス情報を表示して URL をコピーする API インスタンスの名前と URL を表示し、URL をコピーする手順は、次のとおりです。 1. **\[API Details (API 詳細)\]**​ ページで、​**\[View instances (インスタンスを表示)\]**​ をクリックします。 2. コピーアイコンをクリックします。 3. **\[Close (閉じる)\]**​ をクリックします。 ## [](#関連情報)関連情報 - [API インスタンスへのアクセス権の要求](https://docs.mulesoft.com/jp/api-experience-hub/requesting-access-to-an-api-instance) # Chatter フィード追跡の設定 ポータルコミュニティと交流するには、Chatter フィード追跡を追加します。Chatter 追跡を使用すると、ポータルメンバーは API に関するディスカッションを作成し、リアルタイムの最新情報や通知を取得し、エキスパートにアドバイスを求め、関連するディスカッションを確認することができます。 既存の API Portal の場合、エクスペリエンスビルダーを使用してフィードおよびフィードパブリッシャーコンポーネントを手動で追加する必要があります。 ## [](#フィード追跡を有効にする)フィード追跡を有効にする 1. Salesforce で ​**\[設定\]**​ をクリックします。 2. **\[クイック検索\]**​ ボックスに​**「フィード追跡」**​と入力し、​**\[フィード追跡\]**​ をクリックします。 3. **\[Community Asset (コミュニティアセット)\]**​ を選択し、​**\[フィード追跡の有効化\]**​ を選択します。 4. **\[保存\]**​ をクリックします。 ## [](#既存の-api-portal-のフィードコンポーネントを追加する)既存の API Portal のフィードコンポーネントを追加する 既存のポータルのフィードコンポーネントを追加する手順は、次のとおりです。 1. ビルダーに移動します。 2. **\[プレビュー\]**​ モードで、​**\[API Details (API 詳細)\]**​ ページの ​**\[ビルダーに戻る\]**​ をクリックします。 3. **\[コンポーネント\]**​ をクリックし、​**\[タブのレイアウト (新規)\]**​ コンポーネントをクリックします。 4. **\[タブのレイアウト (新規)\]**​ ダイアログで、​**\[追加\]**​ をクリックします。 5. **\[タブ名\]**​ 項目に、​**「Feedback and discussions」**​ (フィードバックとディスカッション) またはタブの任意の名前を入力し、​**\[保存\]**​ をクリックします。 6. **\[保存\]**​ をクリックします。 7. **\[コンポーネント\]**​ をクリックし、​**\[検索\]**​ ボックスに​**「フィード」**​と入力します。 8. **\[Feedback and discussions (フィードバックとディスカッション)\]**​ の ​**\[タブのレイアウト (新規)\]**​ に ​**\[フィード\]**​ コンポーネントと ​**\[フィードパブリッシャー\]**​ コンポーネントをドラッグします。 ## [](#関連情報)関連情報 - [フィードコンポーネントを設定する](https://docs.mulesoft.com/jp/api-experience-hub/common-builder-customizations#configure-feed-component) - [フィードパブリッシャーコンポーネントを設定する](https://docs.mulesoft.com/jp/api-experience-hub/common-builder-customizations#configure-feed-publisher-component) # CSS を使用した高度なスタイリング API Experience Hub では、API Experience Hub の一般的なコンポーネント向けのカスケードスタイルシート (CSS) という編集可能なサイトによる高度なスタイリング機能が提供されます。 以下のセクションでは、使用できるオプションについて簡単に説明します。詳細については、『Experience Cloud 開発者ガイド』の [「カスタム CSS によるテンプレート要素の上書き」](https://developer.salesforce.com/docs/atlas.en-us.communities_dev.meta/communities_dev/communities_dev_customize_css.htm)​を参照してください。 ## [](#css-を編集する)CSS を編集する 1. **\[ビルダー\]**​ で、ペイントブラシアイコンをクリックして ​**\[テーマ\]**​ メニューを開きます。 2. メニューのドロップダウン矢印を選択して ​**\[CSS を編集\]**​ を選択します。 3. **\[CSS を編集\]**​ ダイアログボックスで CSS ファイルを編集します。 4. 変更が終わったら ​**\[保存\]**​ を選択します。 ## [](#例)例 CSS を使用して API Experience Hub テーマの色を変更できます。 ```css search-bar-container { background: #342b4a!important; } ``` ## [](#css-クラス)CSS クラス ### [](#api-card-api-カード)API Card (API カード) このコンポーネントは API カルーセルや API カタログに含まれます。API カードは、アセットに関する基本情報 (名前、説明、アイコン、タイプ、最終更新日) を表示します。
クラス 説明

.asset-card-container

アセットカードのメインコンテナ。

.asset-card-header-icon

アセットアイコンコンテナ。

.asset-card-type

アセットカードタイプテキスト。たとえば、HTTP-API、REST-API、または SOAP-API。

.asset-card-name

アセットカード名テキスト。

.asset-card-description

アセットカード説明テキスト。

.asset-card-last-updated

アセットカード最終更新テキスト。

### [](#api-carousel-api-カルーセル)API Carousel (API カルーセル) このコンポーネントはホームページに表示されます。API カルーセルは、一度に最大 5 つのアセットが表示されるカルーセルとして API カードを表示します。

クラス

説明

.assets-carousel-container

メインカルーセルコンテナ。

.assets-carousel-title

アセットのカルーセルタイトル。

.assets-carousel-sub-title

アセットのカルーセルサブタイトル。

.assets-carousel-view-all-link

すべてのアセットリンクを表示。

.base-carousel-arrow-button-left

左カルーセルボタン。

.base-carousel-arrow-button-right

右カルーセルボタン。

.base-carousel-dots-container

ボトムナビゲーションドットのコンテナ。

.base-carousel-dot

ナビゲーションドット。

.base-carousel-dot-selected

選択済みのナビゲーションドット。

### [](#api-catalog-api-カタログ)API Catalog (API カタログ) このコンポーネントは、サイトのすべてのアセットを表示します。ユーザーはアセットを検索してアセットタイプで絞り込むことができます。

クラス

説明

.assets-catalog-container

メインカタログコンテナ。検索条件が含まれるヘッダーとアセットカードが含まれる本文が含まれます。

.assets-catalog-header-container​

ヘッダーカタログコンテナ。検索条件が含まれます。

.assets-catalog-header-search

検索入力コンテナ。

.assets-catalog-header-filters-container​

右側のアセットタイプ検索条件と [Clear all (すべてクリア)] ボタンのコンテナ。

.assets-catalog-header-filter-type-container

アセットタイプ検索条件のコンテナ。

.assets-catalog-header-clear-all​

[Clear all (すべてクリア)] ボタン。

.assets-catalog-body-container​

すべてのアセットカードが含まれる本文コンテナ。

### [](#アプリケーション詳細)アプリケーション詳細 このコンポーネントは、アプリケーション情報 (名前、説明、アプリケーション URL、リダイレクト URI、許可種別) を表示します。

クラス

説明

.application-details-header-name​

アプリケーション名。

.application-details-header-description-container​

アプリケーションの説明。

.application-details-header-application-url-container

アプリケーション URL コンテナ。

.application-details-header-application-url​

アプリケーション URL の表示ラベル。

.applications-details-cards​

クライアントログイン情報カード、リダイレクト URI カード、許可種別カードのコンテナ。

.application-details-card​

カードコンテナ。

.application-details-card-header-title​

カードタイトル。

.application-details-card-content​

カードコンテンツ。

.application-details-card-content-data .label​

クライアントログイン情報カード: クライアント ID とクライアントシークレットの表示ラベル。

.application-details-card-content-data .value​

クライアントログイン情報カード: クライアント ID とクライアントシークレットの値。

.application-details-card-uri​

リダイレクト URI カード: アプリケーション URI。

.application-details-grant-type​

許可種別カード: アプリケーションの許可種別。

### [](#application-listing-アプリケーションリスト)Application Listing (アプリケーションリスト) このコンポーネントは、ユーザーが作成したアプリケーションを表示します。アプリケーションは名前および説明により絞り込むことができます。

クラス

説明

.applications-listing-search-container​

アプリケーションリストの検索入力コンテナ。

.applications-listing-table-container​

アプリケーションテーブルコンテナ。

.applications-listing-table .name-column​

アプリケーション名テーブルヘッダーの表示ラベル。

.applications-listing-table​

.description-column​

アプリケーションの説明テーブルヘッダーの表示ラベル。

.applications-listing-table .credentials-column​

アプリケーションログイン情報テーブルヘッダーの表示ラベル。

.applications-listing-table-row​

アプリケーション行が含まれる各テーブル要素。

.applications-listing-table-row​

.name-cell​

アプリケーション名。

.applications-listing-table-row​

.description-cell​

アプリケーションの説明。

.applications-listing-table-row​

.credentials-icon​

ログイン情報アイコンを表示。

.applications-listing-table-row​

.credentials-label​

ログイン情報の表示ラベルを表示。

.applications-listing-table-row-credentials​

ログイン情報のポップアップコンテナ。

.applications-listing-table-row-credentials `​

`.crendetials-tooltip-title​

クライアント ID とクライアントシークレットの表示ラベル。

`.applications-listing-table-row-credentials `​

.crendetials-tooltip-code

アプリケーションのクライアント ID とシークレットコード。

### [](#asset-documentation-viewer-api-overview-アセットドキュメントビューアー-api-概要)Asset Documentation Viewer (API Overview) (アセットドキュメントビューアー (API 概要)) (公開コンポーネント) このコンポーネントは API 詳細ページに含まれます。 アセットからのページが表示されます。このページは Exchange から要求されます。

クラス

説明

.asset-documentation-viewer-container

アセットドキュメントビューアーのプリンシパルコンテナ。

asset-documentation-viewer-spinner-container

アセット詳細ヘッダー以降のドキュメント要求情報中に実行されるスピナーコンテナ。

.asset-documentation-viewer-spinner-container​

​.asset-documentation-viewer-spinner​

アセット詳細ヘッダー以降のドキュメント要求情報中に実行されるスピナー。

.asset-documentation-viewer-pages-container​

アセットドキュメントビューアーページコンテナのコンテナ。このコンテナは、ナビゲーションバーの有無に関係なく使用できます。

.asset-documentation-viewer-pages-tabs

アセットドキュメントページを表示するためのナビゲーションバー。

.asset-documentation-viewer-pages-spinner-container​

Exchange からのページコンテンツの要求時に実行されるスピナーコンテナ。

.asset-documentation-viewer-pages-spinner-container​

.asset-documentation-viewer-pages-spinner​

Exchange からのページコンテンツの要求中に実行されるスピナー。

.asset-documentation-pages-base-error

Exchange からのコンテンツの要求に失敗した時に表示されるコンテナ。

c-base-error を表示。

.asset-documentation-viewer-pages-one-page-container

アセットに 1 ページしかない場合に表示されるコンテナ。この場合、ナビゲーションバーは表示されません。

.asset-documentation-viewer-markdown

マークダウンが表示される div 要素。

### [](#asset-detail-header-アセット詳細ヘッダー)Asset Detail Header (アセット詳細ヘッダー) (公開コンポーネント) このコンポーネントは API 詳細ページで表示されます。アセットに関する基本情報 (ロゴ、名前、アセットタイプ、情報の連絡先、コンボボックスバージョン、状況、インスタンス、クライアント、仕様のダウンロード、\[Request Access (アクセス権の要求)\] ボタン) が表示されます

クラス

説明

asset-detail-header-container

アセット詳細ヘッダーのプリンシパルコンテナ。

.asset-detail-header-spinner-container​

ページが読み込まれるときに実行されるスピナーコンテナ。

.asset-version-header-index-information-collapsible

アセット情報の折りたたみ可能なボタン。

.asset-version-header-index-information-icon​

.asset-type-{assetType}-background-color​

アセットアイコンの背景色。 assetType:

rest-api

evented-api

http-api

soap-api

.asset-version-header-index-information-icon​

.asset-type-{this.assetType}-border-color​

アセットアイコンの境界線の色。 assetType:

rest-api

evented-api

http-api

soap-api

.asset-version-header-index-information-title-container​

.asset-version-header-index-information-title

アセットのタイトル。

.asset-detail-header-index-content-version-action-buttons​

.asset-detail-header-index-content-version-download-button-button​

[Download spec (仕様をダウンロード)] ボタン。

.asset-detail-header-index-content-version-action-buttons​

.asset-detail-header-index-content-version-download-button-modal

ユーザーが ​[Download (ダウンロード)]​ をクリックしたときに開くオプションが含まれるモーダル。

.asset-version-header-index-information-detail​

.asset-type

アセットタイプ。

.asset-version-header-index-information-detail​

.name

連絡先名。

.asset-version-header-index-information-detail​

.email-link​

連絡先メール。

.asset-version-header-index-information-description​

.description

アセットの説明。

.asset-detail-header-index-content-version-main-container​

.asset-detail-header-index-content-version-spinner-container

ユーザーが選択するバージョンを変更したときに実行されるスピナーコンテナ。

.asset-detail-header-index-content-version-element-detail​

.header

コンテンツバージョン内のアクションのタイトル。アセットバージョン、アセットの状態、インスタンス、クライアント。すべての要素に適用されます。

.asset-detail-header-index-content-version-element-detail​

.body

コンテンツバージョン内のアクションの本文。アセットバージョン、アセットの状態、インスタンス、クライアント。すべての要素に適用されます。

.asset-detail-header-index-content-version-element-detail​

.status

アセットの状況を表示。

.asset-detail-header-index-content-version-element-detail​

.instances

アセットのインスタンスの数。

.asset-detail-header-index-content-version-element-detail​

.number-contracts

アセットのコントラクトの数。

.asset-detail-header-index-content-version-element-detail​

.asset-detail-header-index-content-version-select-container`​

アセットのバージョンを選択するコンテナ。

c-base-title-selector を表示。

### [](#base-error-基本エラー)Base Error (基本エラー) (非公開コンポーネント) このコンポーネントは、エラーまたは空の状態のメッセージを表示するためにアセット詳細ヘッダーまたはアセットドキュメントビューアーとして他の公開コンポーネントによって使用されます。

クラス

説明

.base-error-container

コンポーネントのメインコンテナ。

.base-error-svg-icon-container

メインアイコンが含まれる要素。

.base-error-text

エラーまたは空の状態のメッセージのタイトル。

.base-error-sub-text

エラーまたは空の状態のメッセージのサブタイトル。

.base-error-request-id

一部のエラーでは、要求 ID が表示されます。

.base-error-try-again

一部のエラーでは、失敗したアクションをもう一度実行するボタンが表示されます。

### [](#アクセス権の要求)アクセス権の要求 (非公開コンポーネント) このコンポーネントは、エラーまたは空の状態のメッセージを表示するためにアセット詳細ヘッダーまたはアセットドキュメントビューアーとして他の公開コンポーネントによって使用されます。

クラス

説明

.request-access-container​

[Request access (アクセス権の要求)] ボタンのコンテナ。

.request-access-button

アセット詳細ヘッダー内の [Request access (アクセス権の要求)] ボタン。

.request-access-button-label

[Request access (アクセス権の要求)] ボタンの表示ラベル。

.request-access-modal-content

[Request access (アクセス権の要求)] モーダルのコンテンツのコンテナ。

.request-access-modal-footer

[Request access (アクセス権の要求)] モーダルのフッターのコンテナ。

.request-access-field-label

[Request access (アクセス権の要求)] モーダルのフォーム入力の表示ラベル。

.request-access-field-subtitle

[Request access (アクセス権の要求)] モーダルのフォーム入力のサブタイトル。

.request-access-field-content

[Request access (アクセス権の要求)] モーダルのフォーム入力のコンテンツ。

.request-access-modal-new-application

新規アプリケーションフォームのコンテナ。

.request-access-new-application-form-title

新規アプリケーションタイトルを作成。

.request-access-input-content.name

新規アプリケーションの入力名。

.request-access-input-content.description

新規アプリケーションの入力の説明。

.request-access-input-content.url

新規アプリケーションの URL 入力。

.request-access-input-content.redirectUri

新規アプリケーションのリダイレクト URI 入力。

.request-access-modal-button

[Cancel (キャンセル)] および [Request access (アクセス権の要求)] モーダルボタン。

.request-access-modal-button.confirm

[Request access (アクセス権の要求)] モーダルボタン。

## [](#関連情報)関連情報 - [ポータルのプレビューとパブリッシュ](https://docs.mulesoft.com/jp/api-experience-hub/previewing-and-publishing-your-portal) # ID プロバイダーが Anypoint Platform 用にすでに設定されている場合の SSO の設定 このユースケースには、Anypoint Platform 用にすでに設定されている ID プロバイダーを使用してポータルの SSO を設定する手順が含まれています。このユースケースでは、ポータルと Anypoint Platform のユーザー名が一致しない場合に​[ユーザー名の割り当て戦略](https://docs.mulesoft.com/jp/api-experience-hub/enabling-sso-for-your-portal#username-strategy)​を調整する手順も提供されます。 このユースケースの手順では、ID プロバイダーの例として Okta を使用していますが、任意の ID プロバイダーを使用して SSO をセットアップできます。 ## [](#始める前に)始める前に 次のセットアップとコンテキストがあることを確認してください。 - Anypoint Platform の ID プロバイダーがすでに設定されている。 - アプリケーションにアクセスできるユーザーまたはユーザーのグループの ID が ID プロバイダーで作成されている。 - ID プロバイダーのカスタムユーザー属性とクレームを設定するために API Experience Hub に必要なロール、権限、情報を理解する。 [「始める前に」](https://docs.mulesoft.com/jp/api-experience-hub/enabling-sso-for-your-portal#before-you-begin)​を参照してください。 ## [](#ステップ-1-ポータルの-sso-を有効にする)ステップ 1 - ポータルの SSO を有効にする このステップでは、API Experience Hub ポータルの ID プロバイダーでアプリケーションを作成および設定し、アプリケーション設定でグループ情報を送信する機能を有効にし、グループを設定し、アプリケーションを Anypoint Platform の ID プロバイダーにマップします。これらの手順を実行するには、アプリケーションと ID プロバイダーアプリケーション間を行き来して情報をコピーまたは追加する必要があります。 ### [](#アプリケーションを作成および設定する)アプリケーションを作成および設定する ID プロバイダーで API Experience Hub ポータル用の新しいアプリケーションを作成します。 1. Okta で、OpenID Connect Web アプリケーションを作成します。詳細は、 [「Create OIDC app integrations (OIDC アプリケーションインテグレーションの作成)」](https://help.okta.com/oie/en-us/content/topics/apps/apps_app_integration_wizard_oidc.htm)​を参照してください。 2. **\[Connection (一般設定)\]**​ セクションで、次の項目に入力します。
項目 値

App integration name (アプリケーションインテグレーション名)

アプリケーションの名前を入力します。

Grant tpe (許可種別)

[Authorization Code (認証コード)]​ を選択します。

Assignments (割り当て)

[Limit access to selected groups (選択済みのグループへのアクセスを制限)]​ を選択します。

Selected group(s) (選択済みのグループ)

API Experience Hub および Anypoint Platform のアプリケーションにアクセスする必要があるグループの名前を入力します。

3. ID プロバイダーが、​[「始める前に」](https://docs.mulesoft.com/jp/api-experience-hub/enabling-sso-for-your-portal#before-you-begin)​セクションにリストされた予期されるクレームを送信していることを確認します。 4. アプリケーションが送信するクレームを設定します。 たとえば、OpenID Connect の場合、次の手順を使用してグループクレームを設定します。 1. **\[Sign On (サインオン)\]**​ タブで、​**\[OpenID Connect ID Token (OpenID Connect ID トークン)\]**​ セクションの ​**\[Edit (編集)\]**​ をクリックします。 2. **\[Groups claim type (グループクレーム種別)\]**​ で、​**\[Filter (検索条件)\]**​ を選択します。 3. **\[Groups claim filter (グループクレーム検索条件)\]**​ で、​`[groups (グループ)]`​ を入力します。 4. 式で ​**\[Matches regex\]**​ を選択し、ワイルドカードに​**「.」**\*​を入力します。 ![グループクレーム検索条件の例](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-groups-claim-filter.png) ### [](#openid-connect-を使用して-salesforce-の認証プロバイダーを設定する)OpenID Connect を使用して Salesforce の認証プロバイダーを設定する ID プロバイダーアプリケーション情報を使用して、Salesforce で認証プロバイダーまたは SSO 設定をセットアップします。 1. OpenID Connect アプリケーションから、次の設定値を取得します。 - **Client ID (クライアント ID)** - **Client Secret (クライアントシークレット)** - **Authorize Endpoint URL (承認エンドポイント URL)** - **Token Endpoint URL (トークンエンドポイント URL)** - **User Info Endpoint URL (ユーザー情報 エンドポイント URL)** 2. **Salesforce**​ で ​**\[設定\]**​ に移動します。 3. **\[クイック検索\]**​ ボックスに​`「認証」`​と入力し、​**\[認証プロバイダー\]**​ を選択します。 4. **\[新規\]**​ をクリックします。 5. **\[プロバイダータイプ\]**​ 項目で、​**\[OpenID Connect\]**​ を選択します。 6. 次の項目に入力します。
項目 値

プロバイダータイプ

OpenID Connect​

名前

プロバイダーの名前を入力します。

コンシューマーキー

ID プロバイダーのクライアント ID を入力します。

コンシューマーの秘密

ID プロバイダーのクライアントシークレットを入力します。

Authorize Endpoint URL (承認エンドポイント URL)

https://{domainofOktaorg}.okta.com/oauth2/v1/authorize*​ と入力します。

Token Endpoint URL (トークンエンドポイント URL)

https://{domainofOktaorg}.okta.com/oauth2/v1/token​ と入力します。

User Info Endpoint URL (ユーザー情報 エンドポイント URL)

https://{domainofOktaorg}.okta.com/oauth2/v1/userinfo`​ と入力します。

デフォルトのスコープ​

profile openid email groups (プロファイルの openid メールグループ)​

登録ハンドラー

AEHPortalRegistrationHandler​

他のアカウントで登録を実行

システム管理者ユーザーを選択します。

![Salesforce 認証プロバイダーの例](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-salesforce-auth-provider.png) 7. **\[保存\]**​ をクリックします。 ### [](#ポータルのリダイレクト-uri-を設定する)ポータルのリダイレクト URI を設定する リダイレクトを設定するには、15 桁の組織 ID と 18 桁の組織 ID を使用し、各組織 ID の URL を追加します。 1. Okta アプリケーションで、​**\[General (一般)\]**​ タブを選択します。 2. **\[Sign-in redirect URIs (サインインリダイレクト URI)\]**​ に次の URL を追加します。 - [https://login.salesforce.com/services/authcallback/${15DigitSalesforceOrganizationId}/${authProviderURLSuffix}](https://login.salesforce.com/services/authcallback/${15DigitSalesforceOrganizationId}/${authProviderURLSuffix}) - [https://login.salesforce.com/services/authcallback/${18DigitSalesforceOrganizationId}/${authProviderURLSuffix}](https://login.salesforce.com/services/authcallback/${18DigitSalesforceOrganizationId}/${authProviderURLSuffix}) - [https://${domain}.my.site.com/aeh/services/authcallback/${authProviderURLSuffix}](https://${domain}.my.site.com/aeh/services/authcallback/${authProviderURLSuffix}) ![リダイレクト URI の例](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-sso-redirect-uris.png) URL を取得する手順は、次のとおりです。 - salesforceOrganizationId の場合、​**\[設定\]**​ > ​**\[組織情報\]**​ に移動する。 - authProviderURLSuffix の場合、​**\[設定\]**​ > ​**\[認証プロバイダー\]**​ に移動し、認証プロバイダーをクリックして ​**\[URL 接尾辞\]**​ を選択する。 - domain の場合、​**\[設定\]**​ > ​**\[私のドメイン\]**​ > ​**\[現在の \[私のドメイン\] の URL\]**​ に移動する。 ### [](#anypoint-platform-の-id-プロバイダーにアプリケーションをマップする)Anypoint Platform の ID プロバイダーにアプリケーションをマップする anypoint\_idp\_id という新しいカスタム属性を追加して設定することで、ID プロバイダー ID を anypoint\_idp\_id にマップする必要があります。 ポータルと Anypoint Platform のユーザー名が一致しない場合、anypoint\_username という別のカスタム属性を追加して、ポータルの ID と Anypoint Platform のユーザーが一致するように既存の ID プロバイダーユーザーを強制的に更新します。 anypoint\_idp\_id を Anypoint Platform ID プロバイダー ID にマップする手順は、次のとおりです。 1. Okta アプリケーションで、​**\[Directory (ディレクトリ)\]**​ > ​**\[Profile Editor (プロファイルエディター)\]**​ に移動します。 2. 設定したポータルアプリケーションを選択します。 3. **\[Add Attributes (属性を追加)\]**​ をクリックし、​**anypoint\_idp\_id**​ という新しい属性を作成します。 4. 次の項目に入力します。
項目 値

Display name (表示名)

anypoint_idp_id

Value name (値の名前)

anypoint_idp_id

5. 変更を保存します。 6. **\[Access Management (アクセス管理)\]**​ > ​**\[Identity Providers (ID プロバイダー)\]**​ に移動し、ID プロバイダーをクリックします。 7. ブラウザーの URL から 32 桁の ID をコピーします。 ![ブラウザーの URL にある 32 桁の例](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-sso-32-digit-id.png) 8. **\[Okta\]**​ > ​**\[Directory (ディレクトリ)\]**​ > ​**\[Profile Editor (プロファイルエディター)\]**​ に移動し、​**\[Mappings (マッピング)\]**​ をクリックします。 9. 新しい anypoint\_idp\_id 属性の空の項目に ID を貼り付けます。ID は引用符で囲む必要があります。 10. 黄色い矢印ドロップダウンメニューから、​**\[Apply mapping on user create and update (ユーザーの作成および更新時にマッピングを適用)\]**​ を選択します。 ![マップされた anypoint\_idp\_id 属性の例](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-sso-mapped-anypoint-idp-id-attribute.png) 11. **\[Save Mappings (マッピングを保存)\]**​ をクリックします。 12. プロファイル内のすべてのユーザーにマッピングを適用します。 ユーザーがすでに存在し、anypoint\_idp\_id が設定される前にポータルにログインしている場合、デフォルトの ID プロバイダー \[AEH Users (AEH ユーザー) - ${salesforceOrganizationId}\] が使用されます。ユーザーが複製されることを防ぐため、ユーザーは anypoint\_idp\_id 項目で指定された新しい ID プロバイダーには追加されません。 ユーザーが Salesforce にすでに存在し、SSO を使用してポータルにログインしている場合、「API Experience Hub Member User (API Experience Hub メンバーユーザー)」権限セットがそのユーザーに割り当てられます (権限セットがまだ割り当てられていない場合)。 ポータルと Anypoint Platform での 1 つの ID に対するユーザー名の割り当てを調整する手順は、次のとおりです。 1. Okta アプリケーションで、​**\[Directory (ディレクトリ)\]**​ > ​**\[Profile Editor (プロファイルエディター)\]**​ に移動します。 2. 設定したポータルアプリケーションを選択します。 3. **\[Add Attributes (属性を追加)\]**​ をクリックし、​**anypoint\_username**​ という新しい属性を作成します。 4. 次の項目に入力します。
項目 値

Display name (表示名)

anypoint_username

Value name (値の名前)

anypoint_username

5. 変更を保存します。 6. **\[Mappings (マッピング)\]**​ をクリックします。 7. 新しい ​**anypoint\_username**​ 属性の空の項目に、​`String.substringBefore(user.login, "@")`​ と入力します。Okta ユーザー名はメールベースであるため、この式ではメールドメインが削除されます。 8. 黄色い矢印ドロップダウンメニューから、​**\[Apply mapping on user create and update (ユーザーの作成および更新時にマッピングを適用)\]**​ を選択します。 ![マップされた anypoint\_username 属性の例](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-sso-mapped-anypoint-username-attribute.png) 9. **\[Save Mappings (マッピングを保存)\]**​ をクリックします。 ## [](#ステップ-2-salesforce-id-プロバイダーを追加する)ステップ 2: Salesforce ID プロバイダーを追加する API Experience Hub UI から Salesforce ID プロバイダーを有効にします。ID プロバイダーが有効になっている場合、ユーザーはこの ID プロバイダーを使用してポータルにログインできます。 1. **\[API Experience Hub\]**​ > ​**\[User management (ユーザー管理)\]**​ に移動します。 2. **\[User management (ユーザー管理)\]**​ ページで、​**\[Login settings (ログイン設定)\]**​ タブを選択します。 3. **\[Single sign-on (SSO) (シングルサインオン (SSO))\]**​ セクションから、​**\[Add Salesforce identity providers (Salesforce ID プロバイダーを追加)\]**​ セクションまでスクロールダウンします。 4. Okta で設定した Salesforce ID プロバイダーで、スライダーを ​**\[Enabled (有効)\]**​ に移動します。 ## [](#ステップ-3-グループマッピングを追加する)ステップ 3: グループマッピングを追加する ポータルの SSO を設定する場合、ユーザーは Salesforce と Anypoint Platform の両方で ID を持っている必要があります。SSO ユーザーは、グループ名を使用してチームにマップされます。アクセス管理を使用して、ユーザーをチームにマップする必要があります。API Experience Hub には、​**\[AEH Portal (AEH ポータル) - ${salesforceOrganizationId}\_${salesforceCommunityId}\]**​ という標準のチームが用意されており、アクセス管理のチームとして自動的に追加されています。 API Experience Hub で対応するプロファイルにユーザーを追加することで、グループマッピングを追加します。 1. **\[Access Management (アクセス管理)\]**​ > ​**\[Teams (チーム)\]**​ に移動します。 2. **\[AEH Portal Guests (AEH ポータルゲスト)\]**​ を選択し、​**\[AEH Portal Members (AEH ポータルメンバー)\]**​ を選択します。 3. **\[External IdP Groups (外部 IdP グループ)\]**​ を選択します。 4. **\[Group Name (グループ名)\]**​ 項目に​**「AEH Members」**​ (AEH メンバー) と入力します。 5. **\[Provider Name (プロバイダー名)\]**​ 項目で、対応する Salesforce ID プロバイダーの名前を選択します。 6. **\[Type (種別)\]**​ 項目で ​**\[Member (メンバー)\]**​ を選択し、​**\[Add (追加)\]**​ をクリックします。 ![アクセス管理グループマッピング](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-sso-access-mgmt-ext-idp-groups.png) 7. **\[Save Changes (変更を保存)\]**​ をクリックします。 指定したグループに関連付けられている SSO ユーザーがチームに割り当てられます。 ## [](#test-sso)ステップ 4: SSO 設定をテストする ポータルの SSO が正しく設定されていることを確認します。 1. ブラウザーでシークレットウィンドウを開きます。 2. API Experience Hub ポータルに移動します。 3. 設定した SSO オプションを選択します。 4. ポータルの ID プロバイダーで設定したグループに属するユーザーでログインします。 5. ポータルでのユーザーの API の表示を確認します。 6. **\[Access Management (アクセス管理)\]**​ > ​**\[Users (ユーザー)\]**​ に移動します。 7. ユーザー名を使用して検索し、ユーザーが目的の ID プロバイダーにマップされていることを確認します。 8. グループマッピングが設定されているチームに移動します。 **\[Members (メンバー)\]**​ タブで、ユーザーが表示されていることを確認します。 ## [](#関連情報)関連情報 - [シングルサインオンエラーのトラブルシューティング](https://docs.mulesoft.com/jp/api-experience-hub/troubleshoot-sso-errors) - [ポータルでのシングルサインオンの有効化](https://docs.mulesoft.com/jp/api-experience-hub/enabling-sso-for-your-portal) - [ユーザーの管理](https://docs.mulesoft.com/jp/api-experience-hub/managing-users) # My Applications (マイアプリケーション) **\[My Applications (マイアプリケーション)\]**​ ページでは、API とのコントラクトを保持するアプリケーションのリストを確認できます。各クライアントアプリケーションには、クライアント ID、クライアントシークレット、説明、URL、リダイレクト URI、許可種別があります。 クライアント ID 適用ポリシーによって保護されている API では、クライアントアプリケーションはクライアント ID とクライアントシークレット (省略可能) を提供する必要があります。クライアントアプリケーションが登録されると、クライアント ID とクライアントシークレットのログイン情報が自動的に作成されます。アプリケーションの登録についての詳細は、​[「API インスタンスへのアクセス権の要求」](https://docs.mulesoft.com/jp/api-experience-hub/requesting-access-to-an-api-instance)​を参照してください。 ## [](#アプリケーションを検索する)アプリケーションを検索する **\[My Applications (マイアプリケーション)\]**​ ページに複数のアプリケーションがリストされている場合、検索ボックスを使用して特定のアプリケーションを検索します。アプリケーション名またはアプリケーションの説明を入力して、Enter キーまたは Return キーを押します。検索条件に一致するアプリケーションの数が検索結果のリストに表示されます。 ## [](#クライアントログイン情報を表示およびコピーする)クライアントログイン情報を表示およびコピーする クライアントアプリケーションの詳細を表示するには、\[My Applications (マイアプリケーション)\] ページで、リストからアプリケーションをクリックして \[Application Details (アプリケーション詳細)\] ページを表示します。 クライアントログイン情報は次の方法で表示してコピーできます。 - \[My Applications (マイアプリケーション)\] ページで ​**\[View credentials (ログイン情報を表示)\]**​ をクリックします。 - クライアント ID またはクライアントシークレットをクリップボードにコピーするには、\[Copy to clipboard (クリップボードにコピー)\] アイコンをクリックします。 - クライアントシークレットを表示するには、\[Show Client Secret (クライアントシークレットを表示)\] アイコンをクリックします。 - クライアントシークレットを非表示にするには、\[Hide Client Secret (クライアントシークレットを非表示)\] アイコンをクリックします。 ## [](#application-details-アプリケーション詳細)Application Details (アプリケーション詳細) クライアントアプリケーションの詳細を表示するには、\[My Applications (マイアプリケーション)\] ページで、リストからアプリケーションをクリックして \[Application Details (アプリケーション詳細)\] ページを表示します。 アプリケーションに関する次の詳細を表示できます。 - Application URL (アプリケーション URL) アプリケーションのインターネットアドレスが表示されます。リンクをクリックすると URL に移動します。 - クライアントログイン情報 アプリケーションのクライアント ID とクライアントシークレットが表示されます。 - OAuth 2.0 Redirects URIs (OAuth 2.0 リダイレクト URI) アプリケーションのリダイレクト URI のリスト。 - OAuth 2.0 Grant Type (OAuth 2.0 許可種別) アプリケーションの許可種別のリスト。 - API Contracts (API コントラクト) \[API contracts (API コントラクト)\] セクションで、アプリケーションの API 参照名、環境およびインスタンス、インスタンス URL、SLA 層、アクセス権の要求の状態を確認できます。環境には、Sandbox または開発環境を指定できます。アクセス権の要求の状態には ​`pending`​、​`approved`​、または ​`failed`​ があります。 \[Application Details (アプリケーション詳細)\] ページでは次のことができます。 - クライアントシークレットをリセットする。 - クライアントアプリケーション詳細を編集する。 - インスタンス URL を表示する。 - SLA 層を追加する。 - SLA 層を変更する。 - クライアントアプリケーションを削除する。 ### [](#クライアントシークレットをリセットする)クライアントシークレットをリセットする アプリケーションのクライアントシークレットを定期的にリセットすることで、ユーザーが組織から去った場合のセキュリティを確保したり、シークレットが誤って権限を持たないユーザーに公開されるのを防止したりできます。 \[Application Details (アプリケーション詳細)\] ページでは、アプリケーションのクライアントシークレットをリセットできます。現在のクライアントシークレットを使用しているアプリケーションは、登録に使用された API にアクセスできなくなります。 クライアントシークレットをリセットする手順は、次のとおりです。 1. **\[Client Credentials (クライアントログイン情報)\]**​ セクションで、​**\[Reset client secret (クライアントシークレットをリセット)\]**​ をクリックします。 2. **\[Confirm (確認)\]**​ をクリックします。 3. 新しいクライアントシークレットを表示するには、\[View (表示)\] アイコンをクリックします。 ### [](#クライアントアプリケーション詳細を編集する)クライアントアプリケーション詳細を編集する \[Application Details (アプリケーション詳細)\] ページで、クライアントアプリケーション名、説明、OAuth 2.0 許可種別、OAuth 2.0 リダイレクト URI、SLA 層を編集できます。 1. **\[My Applications (マイアプリケーション)\]**​ セクションで、リスト内のアプリケーション名をクリックします。 2. **\[Edit (編集)\]**​ をクリックします。 3. **\[Application Details (アプリケーション詳細)\]**​ ページで、対応する項目を編集します。 4. **\[Save (保存)\]**​ をクリックします。 ### [](#インスタンス-url-を表示およびコピーする)インスタンス URL を表示およびコピーする API のインスタンス URL を表示するには、​**\[View URL (URL を表示)\]**​ をクリックします。コピーするには、​**\[Copy from clipboard (クリップボードからコピー)\]**​ アイコンをクリックします。 ### [](#sla-層を追加する)SLA 層を追加する SLA 層は API Manager で定義され、\[Application Details (アプリケーション詳細)\] ページに \[SLA Tier (SLA 層)\] オプションとして表示されます。アプリケーションで SLA 層が表示されない場合は、SLA 層を追加するように要求できます。インスタンスオーナーは層を承認する必要があります。 1. **\[My Applications (マイアプリケーション)\]**​ セクションで、リスト内のアプリケーション名をクリックします。 2. **\[API Contracts (API コントラクト)\]**​ セクションの ​**\[SLA Tier (SLA 層)\]**​ 列で、\[+ Add (+ 追加)\] をクリックします。 3. **\[Add SLA Tier (SLA 層を追加)\]**​ リストで、層のリストから選択します。 4. **\[Save (保存)\]**​ をクリックします。 アクセス権の要求が承認されると、\[Request Access State (アクセス権の要求の状態)\] 列に \[Approved (承認済み)\] 状態が表示され、メンバーにメールが送信されます。 ### [](#sla-層を変更する)SLA 層を変更する SLA 層では、アプリケーションで API に対して実行できる要求数を制限できます。許可される要求数は増やすことも減らすこともできます。\[Application Details (アプリケーション詳細)\] ページで、アプリケーションの SLA 層を変更できます。使用可能な SLA 層は管理者が API マネージャーで設定します。API インスタンスのオーナーは層レベルを変更する要求を承認する必要があります。 クライアントアプリケーションの SLA 層を編集する手順は、次のとおりです。 1. **\[My Applications (マイアプリケーション)\]**​ ページで、リスト内のアプリケーションの名前をクリックします。 2. 変更する ​**\[API Contracts (API コントラクト)\]**​ セクションの ​**\[SLA Tier (SLA 層)\]**​ 列で、SLA 層の編集オプションをクリックします。 3. **\[Edit SLA Tier (SLA 層を編集)\]**​ ダイアログで、SLA 層のリストから選択します。 4. **\[Save (保存)\]**​ をクリックします。 5. **\[Okay (OK)\]**​ をクリックして、メッセージを閉じます。 ### [](#クライアントアプリケーションを削除する)クライアントアプリケーションを削除する API のコントラクトが不要になった場合、削除できます。アプリケーションを削除すると、API とのコントラクトはなくなり、アクセスできなくなります。もう一度アクセスできるようにするには、再び API へのアクセス権を要求する必要があります。 クライアントアプリケーションを削除する手順は、次のとおりです。 1. アプリケーションの ​**\[Application Details (アプリケーション詳細)\]**​ ページで、​**\[Delete (削除)\]**​ をクリックします。 2. **\[Delete application (アプリケーションを削除)\]**​ メッセージで ​**\[Delete (削除)\]**​ をクリックします。 アプリケーションが \[My Applications (マイアプリケーション)\] ページから削除されます。 # Salesforce アカウントおよびポータル情報の表示 **\[設定\]**​ ページには、Salesforce アカウントと API Portal に関する情報が表示されます。 Salesforce 組織とポータルに関する情報を表示するには、​**\[Manage your API portal (API Portal を管理)\]**​ ページで ​**\[Settings (設定)\]**​ をクリックします。 Salesforce 組織情報: - Environment (環境) - Username (ユーザー名) - Sandbox name (Sandbox 名) - Organization domain (組織のドメイン) - Organization ID (組織 ID) API Portal 情報: - Status (状況) - Published status (パブリッシュ状況) - API Portal URL ## [](#関連情報)関連情報 - [ポータルの切断](https://docs.mulesoft.com/jp/api-experience-hub/disconnecting-the-portal) # Salesforce への接続 API Experience Hub には、Experience Cloud を使用している Salesforce 組織と、管理パッケージが含まれます。管理パッケージはオンボーディングプロセス中にインストールされます。API Experience Hub 管理者、またはシステム管理者プロファイルか ​[AEH\_A​nypoint 権限セット](https://docs.mulesoft.com/jp/api-experience-hub/user-roles-permissions-and-profiles)​を持つ Salesforce ユーザーが、Salesforce 組織を Anypoint Platform 組織に接続します。管理パッケージには、Anypoint Platform 組織とやり取りするためのコンポーネントとデータオブジェクトが入っています。Salesforce システム管理者は、Salesforce から ​**\[設定\]**​ > ​**\[インストール済みパッケージ\]**​ に移動し、​**\[API Experience Hub Package\]**​ を選択することで、Salesforce 組織内で ​**API Experience Hub**​ パッケージを表示できます。 Salesforce 組織にリンクして Anypoint Platform 内に API Portal を作成するには、Salesforce Experience Cloud との接続が必要です。このプロセスは、ポータルを作成するために 1 回だけ実行する必要があります。現在、API Experience Hub のインスタンスは、1 つの Anypoint プラットフォーム組織と 1 つの Salesforce 組織にのみ接続できます。 ## [](#接続アプリケーション)接続アプリケーション API Experience Hub では、接続アプリケーションを使用して Anypoint Platform のセッショントークンを取得して Salesforce API とやり取りします。 Salesforce 組織で作成された接続アプリケーションを表示する手順は、次のとおりです。 1. Salesforce で ​**\[設定\]**​ をクリックします。 2. **\[クイック検索\]**​ ボックスに​**「アプリケーション管理」**​と入力し、​**\[アプリケーションマネージャー\]**​ をクリックします。 接続アプリケーション (Anypoint\_AEH) がテーブルにリストされます。 このリリースでは、接続アプリケーションの IP 制限はサポートされません。接続アプリケーションは、組織の信頼済み IP 範囲をバイパスします。このオプションを変更すると、ポータルの作成時にエラーが発生するため、変更しないでください。詳細は、​[「トラブルシューティング」](https://docs.mulesoft.com/jp/api-experience-hub/troubleshooting)​を参照してください。 ## [](#アクセスの許可)アクセスの許可 接続プロセスを実行するには、API Experience Hub に次へのアクセスを許可してください。 - ID URL サービスにアクセス - Web ブラウザーを使用してユーザーデータを管理 - API を使用してユーザーデータを管理 - いつでも要求を実行 ## [](#管理者チーム)管理者チーム API Experience Hub 管理者チームと API Experience Hub ポータル管理者チームは接続およびリンクプロセス中に作成されます。Salesforce 組織が Anypoint Platform 組織に正常に接続されると、AEH 管理者チームが作成されます。Salesforce リンクプロセスが完了すると、AEH 管理者が割り当てられているユーザーが自動的に AEH 管理者チームに追加されます。 ポータルのスタイリング変更が保存されると、AEH ポータル管理者チームが作成されます。API Experience Hub ポータル管理者チームはアクセス管理で表示されますが、この権限はこのリリースではサポートされません。 ## [](#salesforce-への接続を開始する前に)Salesforce への接続を開始する前に - [API Experience Hub の使用開始](https://docs.mulesoft.com/jp/api-experience-hub/getting-started-with-api-experience-hub)の手順をお読みください。 - 接続先となる Salesforce 組織のシステム管理者になっているか、​AEH\_A​nypoint 権限セットを持っていることを確認してください。 ## [](#salesforce-に接続する)Salesforce に接続する この接続プロセスは、ポータルの作成時に 1 回だけ実行する手順です。
Salesforce に接続して組織をリンクできるのは、組織のシステム管理者、API Experience Hub 管理者、またはシステム管理者プロファイルか ​AEH_A​nypoint 権限セットを持つ Salesforce ユーザーのみです。
以下の手順に従って、Salesforce 組織に接続します。 1. Anypoint Platform に移動し、ユーザー名とパスワードを入力して、​**\[Sign in (サインイン)\]**​ をクリックします。 2. Anypoint Platform から ​**\[API Experience Hub\]**​ を選択します。 3. Salesforce に初めて接続する場合は、​**\[Welcome to API Experience Hub (API Experience Hub へようこそ)\]**​ ページで、​**\[Let’s Start (始めましょう)\]**​ をクリックします。 4. **\[Connect to Salesforce (Salesforce に接続)\]**​ をクリックします。 5. 本番でポータルを直接作成するには、​**\[Environment (環境)\]**​ リストから ​**\[Production (本番)\]**​ を選択します。 6. Sandbox でポータルを直接作成するには、​**\[Environment (環境)\]**​ リストから ​**\[Sandbox\]**​ を選択します。 7. Salesforce 組織のユーザー名とパスワードを入力して ​**\[Log In (ログイン)\]**​ をクリックします。 8. カスタム Salesforce ドメインがある場合は、​**\[I have a custom Salesforce domain (カスタム Salesforce ドメインがあります)\]**​ を選択してドメインアドレスを入力します。 カスタムドメインを使用しておらず、選択した環境に有効な Salesforce セッションがある場合は、最初の有効なセッションを使用して Salesforce にログインします。 9. **\[Connect (接続)\]**​ をクリックします。 10. **\[Allow (許可)\]**​ をクリックして MuleSoft がデータにアクセスできるようにします。 11. 戻って別の Salesforce 組織に接続するには、​**\[Connect with another Salesforce organization (別の Salesforce 組織に接続)\]**​ をクリックします。 Salesforce 組織への接続プロセスが再開されます。 12. Salesforce アクセス情報を確認し、​**\[Confirm connection (接続を確認)\]**​ をクリックします。 Salesforce に接続して Salesforce Experience Cloud パッケージをインストールするプロセスが開始されます。パッケージが正常にインストールされたら、メールが届きます。 ## [](#次のステップ)次のステップ Salesforce 組織への接続が完了したら、ポータルをセットアップします。詳細は、[API Portal のセットアップ](https://docs.mulesoft.com/jp/api-experience-hub/setting-up-the-api-portal)を参照してください。 ## [](#関連情報)関連情報 - [ユーザーロール、権限、およびプロファイル](https://docs.mulesoft.com/jp/api-experience-hub/user-roles-permissions-and-profiles) - [権限の割り当て](https://docs.mulesoft.com/jp/api-experience-hub/assigning-permissions) - [Sandbox の操作](https://docs.mulesoft.com/jp/api-experience-hub/working-with-sandboxes) - [トラブルシューティング](https://docs.mulesoft.com/jp/api-experience-hub/troubleshooting) # Sandbox の操作 Salesforce Sandbox 組織を使用して、本番環境と同じ条件の Sandbox 環境でポータルをテストします。API Experience Hub で、API Portal の個別のデプロイメント環境を管理できます。複数の Salesforce Sandbox 組織に接続し、それらを切り替えることができます。現在の Salesforce 接続で使用可能な Sandbox 環境を選択することで、​**\[Manage your API Portal (API Portal を管理)\]**​ ページから Salesforce 組織を管理します。 ## [](#始める前に)始める前に Sandbox 組織がすでにセットアップされていることを確認します。Sandbox の作成についての詳細は、Salesforce ドキュメントの [「Sandbox の作成」](https://help.salesforce.com/s/articleView?id=sf.data_sandbox_create.htm&type=5)​を参照してください。 ## [](#salesforce-組織接続を管理する)Salesforce 組織接続を管理する 1. **\[Manage your API Portal (API Portal を管理)\]**​ ページで、接続コントロールをクリックします。 ![環境を切り替えるための接続コントロール](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-org-switcher.png) 2. オプションを選択します。 - 本番組織に接続するには、​**\[Connected Salesforce Orgs (接続された Salesforce 組織)\]**​ ダイアログで ​**\[Connect production org (本番組織に接続)\]**​ をクリックします。 接続プロセスが再開され、本番組織に接続できるようになります。 - 接続された本番組織の別の Sandbox に切り替えるには、​**\[Connected Salesforce Orgs (接続された Salesforce 組織)\]**​ ダイアログで ​**\[Switch to this org (この組織に切り替え)\]**​ をクリックします。 - 接続されていない Sandbox 組織に接続するには、​**\[Connect (接続)\]**​ をクリックします。 接続プロセスが再開され、Sandbox 組織に接続できるようになります。 - 新しい Sandbox 組織に接続するには、​**\[Connect new sandbox org (新規 Sandbox 組織に接続)\]**​ をクリックします。 接続プロセスが再開され、新しい Sandbox 組織に接続できるようになります。 - 別の Sandbox 組織に切り替えるには、​**\[Switch to this org (この組織に切り替え)\]**​ をクリックします。 ## [](#孤立した-sandbox-を管理する)孤立した Sandbox を管理する 孤立した Sandbox は、本番組織を切断し、子 Sandbox 組織がまだ接続されている場合に発生します。本番組織の子ではない Sandbox に接続すると、その Sandbox は ​**\[Connected Salesforce Organizations (接続された Salesforce 組織)\]**​ ダイアログの ​**\[More sandbox orgs (その他の Sandbox 組織)\]**​ セクションに表示されます。この Sandbox に切り替えることもできます。関連付けられた本番組織に再接続すると、Sandbox は孤立として表示されなくなります。 ## [](#更新された-sandbox-接続を管理する)更新された Sandbox 接続を管理する Sandbox を更新すると、ソース組織からのメタデータが更新されます。本番組織に接続した後に Sandbox が更新された場合は、再接続してこの Sandbox に切り替えます。 本番組織に接続する前に Sandbox が更新された場合は、再接続せずにこの Sandbox に切り替えることができます。 ## [](#sandbox-組織を削除する)Sandbox 組織を削除する Sandbox 組織を削除するには、Salesforce ドキュメントの [「Sandbox を削除する」](https://help.salesforce.com/s/articleView?id=000383260&type=1)​を参照してください。 ## [](#sandbox-の本番への昇格)Sandbox の本番への昇格 Sandbox 環境でポータルをテストし、本番の準備が整ったら、CI/CD パイプラインを使用して Salesforce メタデータのサブセットを本番にデプロイします。その後、Salesforce メタデータのサブセットを使用して本番インスタンスに接続してインストールを完了し、API の選定を開始します。 ### [](#始める前に-2)始める前に 次の基本的な知識があることを確認します。 - バージョン管理システム (VCS) (Git など) - [Salesforce CLI](https://developer.salesforce.com/tools/salesforcecli) - CI/CD パイプラインの概念 - Sandbox 環境で作成された API Portal ### [](#sandbox-を本番に昇格する)Sandbox を本番に昇格する ポータルのスタイル設定とカスタマイズを Sandbox 組織から本番組織に移動します。 1. API Experience Hub メタデータを保存する Git リポジトリを作成します。 1. [Git リポジトリを作成します](https://docs.github.com/en/repositories/creating-and-managing-repositories/quickstart-for-repositories)​。 2. それをローカルマシンにコピーします。 3. [SFDX プロジェクトを作成します](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_create_new.htm)​。 4. `./manifest`​ にマニフェスト ​`package.xml`​ ファイルを作成します。次に例を示します。 Details homeroCompanyLogo homeroLoginBackground minionHomeBanner minionPageBanner ContentAsset API\_Experience\_Hub1\_banner API\_Experience\_Hub1\_logo StaticResource AEH AEH/API\_Experience\_Hub1\_logo Document AEH AEH/ChangedPasswordEmailTemplate AEH/ForgotPasswordEmailTemplate AEH/NewMemberWelcomeEmailTemplate AEH/RejectedMemberEmailTemplate EmailTemplate AEHLetterhead Letterhead Anypoint AnypointDevx AnypointEu AnypointQax AnypointStgx ExchangeAssetIcons ExchangeAssetIconsDevx ExchangeAssetIconsEu ExchangeAssetIconsQax ExchangeAssetIconsStgx GStaticFonts GoogleFonts SegmentAPI SegmentCDN CspTrustedSite Anypoint AnypointDevx AnypointEu AnypointQax AnypointStgx ExchangeAssetIcons ExchangeAssetIconsDevx ExchangeAssetIconsEu ExchangeAssetIconsQax ExchangeAssetIconsStgx SegmentAPI RemoteSiteSetting API\_Experience\_Hub\_Manage\_Networks PermissionSet API Experience Hub Network HTTP\_API\_Audience Audience API\_Experience\_Hub CustomSite API\_Experience\_Hub1 ExperienceBundle AEH\_Default\_Navigation AEH\_Default\_User\_Navigation NavigationMenu cbAPI\_Experience\_Hub NetworkBranding 60.0 5. VCS で開発ブランチを作成します。 6. Salesforce Sandbox 組織から作成されたマニフェストを使用して、メタデータをダウンロードします。 2. Salesforce CLI コマンドを使用して、Salesforce Sandbox 組織からメタデータを取得します。 1. Salesforce Sandbox 組織にログインします。 sf auth web login --instance-url=https:// --alias sandboxOrg 2. Sandbox 組織からメタデータを取得する前に、​`manifest/package.xml`​ ファイルを編集します。 Sandbox 組織は Salesforce 本番組織のコピーであるため、複数の商品からのメタデータを含めることができます。API Experience Hub は、前のステップで Git リポジトリを作成したときに作成された ​`manifest/package.xml`​ ファイルで指定された Sandbox 組織のサブセットです。 3. ポータルにブランド画像が含まれている場合は、その画像を ​`manifest/package.xml`​ の ​`ContentAsset`​ セクションに追加します。次に例を示します。 ... homeroCompanyLogo homeroLoginBackground minionHomeBanner minionPageBanner ContentAsset ... 4. メタデータを確認して、次のコマンドを実行して取得します。 sf project retrieve start --manifest ./manifest/package.xml --target-org sandboxOrg 5. メタデータを確認して、すべてのメタデータの変更を Git リポジトリにコミットします。または、一部のメタデータが欠落しているか不要な場合は、​`manifest/package.xml`​ を変更してこのプロセスを繰り返します。 3. API Experience Hub ポータルを Sandbox 組織から本番組織に移動します。 1. 本番組織にログインします。 sf auth web login --instance-url=https:// --alias productionOrg API Experience Hub 管理パッケージを本番組織にインストールする前に、Sandbox 組織にインストールされている ​`SubscriberPackageVersionId`​ 項目から管理パッケージバージョン ID を取得します。 2. 次のコマンドを実行して、管理パッケージバージョン ID を取得します。API Experience Hub 管理パッケージの ​`SubscriberPackageVersionId`​ 項目は、​`04t`​ で始まります。 sf package installed list --target-org sandboxOrg --json 3. API Experience Hub 管理パッケージを本番組織にインストールします。 sf package install --package 04t... --target-org productionOrg --no-prompt --wait 30 4. Jenkins または他の CI/CD ツールを使用して、API Experience Hub メタデータを本番組織にデプロイします。次に例を示します。 sf project deploy start --source-dir force-app --target-org productionOrg すべての設定が本番組織にデプロイされ、この組織を API Experience Hub に接続する準備が整いました。 4. 本番組織で API Experience Hub を設定します。 1. Anypoint Platform に移動し、ユーザー名とパスワードを入力して、​**\[Sign in (サインイン)\]**​ をクリックします。 2. Anypoint Platform から ​**\[API Experience Hub\]**​ を選択します。 3. Salesforce 本番組織 (Enterprise 組織) を接続します。 4. **\[Use existing portal (既存のポータルを使用)\]**​ をクリックして、既存のポータルを再利用します。 5. **\[API management (API 管理)\]**​ ページで、アセットをポータルに追加します。 6. **\[Preview and publish your portal (ポータルをプレビューしてパブリッシュ)\]**​ をクリックして、ポータルをプレビューし、​**\[Publish (パブリッシュ)\]**​ をクリックします。 ## [](#関連情報)関連情報 - [継続的インテグレーション](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ci.htm) - [Sandbox から本番組織への Experience Cloud サイトのリリース](https://developer.salesforce.com/docs/atlas.en-us.communities_dev.meta/communities_dev/networks_migrate_overview.htm) - [ユーザー参照の保持](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_user_references.htm) - [環境](https://docs.mulesoft.com/jp/access-management/environments) - [API Portal のセットアップ](https://docs.mulesoft.com/jp/api-experience-hub/setting-up-the-api-portal) # エクスペリエンスビルダーを使用したポータルのカスタマイズ 標準のスタイリングテンプレートを使用して API Portal を作成したら、 [エクスペリエンスビルダー](https://help.salesforce.com/s/articleView?id=sf.community_designer_overview.htm&type=5)​を使用してさらにカスタマイズできます。ビルダーでは、サイトのコンポーネント、テーマ、ページ、およびその一般プロパティ、テーマ、SEO の設定を制御して、目的のブランドアイデンティティ、外観、サイト構造の Salesforce Experience Cloud サイトをカスタマイズします。 **\[API management (API 管理)\]**​ ページで、​**\[Preview and publish your portal (ポータルをプレビューしてパブリッシュ)\]**​ リンクによってサイトが開き、ポータルの各ページを編集して新しいページを作成し、各ページでコンポーネントを追加したり編集したりできるようになります。管理者はすべての管理者の共有 ID を使用して Salesforce エクスペリエンスビルダーにアクセスします。管理者の ID は共有されるため、 API Experience Hub は共有アカウントで各管理者のアクションを区別できません。管理者がすでに Salesforce 組織にログインしている場合、​**\[Preview and publish your portal (ポータルをプレビューしてパブリッシュ)\]**​ ボタンをクリックしたときに前のセッションは保持されません。 ビルダーのインターフェースには、ページリスト、コンポーネントパレット、テーマメニュー、ページ構造メニュー、設定メニューが含まれています。 変更を表示して開発者コミュニティのポータル環境を確認するには ​**\[Preview (プレビュー)\]**​ をクリックします。 追加したすべての API を含めて API Carousel (API カルーセル) を表示するには ​**\[Home (ホーム)\]**​ をクリックします。API Catalog (API カタログ) を表示して API の検索や絞り込みを行い、API を選択して API 詳細ページから詳細を取得するには ​**\[APIs (API)\]**​ をクリックします。API 詳細ページでは、上のセクションにメタデータが表示され、下のセクションには API の概要と仕様が表示されます。​**\[Publish (パブリッシュ)\]**​ をクリックして更新内容をパブリッシュします。 ## [](#関連情報)関連情報 - [ポータルの外観のカスタマイズ](https://docs.mulesoft.com/jp/api-experience-hub/look-and-feel-customization) - [API Experience Hub Lightning コンポーネント](https://docs.mulesoft.com/jp/api-experience-hub/api-experience-hub-lightning-components) - [ビルダーを使用した一般的なカスタマイズの実現](https://docs.mulesoft.com/jp/api-experience-hub/common-builder-customizations) - [CSS を使用した高度なスタイリング](https://docs.mulesoft.com/jp/api-experience-hub/advanced-styling-with-css) - [ポータルのプレビューとパブリッシュ](https://docs.mulesoft.com/jp/api-experience-hub/previewing-and-publishing-your-portal) # クライアントアプリケーションとコントラクトの管理 API Experience Hub を通して要求されたクライアントアプリケーションやコントラクトは、API マネージャーで作成されます。SLA 層の設定成に応じて、自動的に承認されるか、API または API グループのオーナーによる承認が必要です。コントラクトを確認して承認する方法は、API マネージャーのドキュメントを参照してください。 ## [](#関連情報)関連情報 - [My Applications (マイアプリケーション)](https://docs.mulesoft.com/jp/api-experience-hub/my-applications) # シングルサインオンエラーのトラブルシューティング 以下のトピックでは、シングルサインオン (SSO) の問題の考えられる原因とトラブルシューティング方法について説明します。 ## [](#リダイレクト-uri-がない)リダイレクト URI がない 外部 ID プロバイダーアプリケーションに適切なリダイレクト URI が定義されていない場合、SSO を使用してポータルにログインすると 400 エラーが発生します。 この問題をトラブルシューティングするには、必要なリダイレクト URI がすべて含まれていることを確認します。 - [https://login.salesforce.com/services/authcallback/${salesforceOrganizationId}/${authProviderURLSuffix}](https://login.salesforce.com/services/authcallback/${salesforceOrganizationId}/${authProviderURLSuffix}) - [https://${domain}.my.salesforce.com/services/authcallback/${authProviderURLSuffix}](https://${domain}.my.salesforce.com/services/authcallback/${authProviderURLSuffix}) - [https://${domain}.my.site.com/aeh/services/authcallback/${authProviderURLSuffix}](https://${domain}.my.site.com/aeh/services/authcallback/${authProviderURLSuffix}) これらのリダイレクト URI を取得する手順は、次のとおりです。 - salesforceOrganizationId: Salesforce で、​**\[設定\]**​ > ​**\[組織情報\]**​ に移動する。 - authProviderURLSuffix: Salesforce で、​**\[設定\] > \[認証プロバイダー\]**​ に移動し、認証プロバイダーの URL 接尾辞を選択する。 - domain: **\[設定\]**​ > ​**\[私のドメイン\]**​ > ​**\[現在の \[私のドメイン\] の URL\]**​ に移動する。 ## [](#アクセス権がない)アクセス権がない SSO を使用してポータルにログインした後に、アクセス権がないエラーが発生します。 この問題をトラブルシューティングするには、ビルダーからポータルをパブリッシュします。 1. **Anypoint Platform**​ に移動し、ユーザー名とパスワードを入力して、​**\[Sign in (サインイン)\]**​ をクリックします。 2. Anypoint Platform から ​**\[API Experience Hub\]**​ を選択します。 3. **\[Manage your API Portal (API Portal を管理)\]**​ ページに移動し、​**\[Preview and publish your portal (ポータルをプレビューしてパブリッシュ)\]**​ をクリックします。 4. **\[Publish (パブリッシュ)\]**​ をクリックします。 ## [](#api-カルーセルが読み込まれない)API カルーセルが読み込まれない ポータルに正常にログインした後に、API カルーセルに API が表示されません。 このエラーが発生する原因として、いくつかの問題が考えられます。 - 外部 ID プロバイダーグループマッピングがアクセス管理にない。 - **\[Auth provider Default Scopes (認証プロバイダーのデフォルトスコープ)\]**​ 項目が正しく設定されていない。 ### [](#外部-id-プロバイダーグループマッピングがないか正しく設定されていない)外部 ID プロバイダーグループマッピングがないか、正しく設定されていない この問題をトラブルシューティングするには、アクセス管理でポータルメンバーユーザーの外部 ID プロバイダーグループマッピングを追加します。 1. **\[Access Management (アクセス管理)\]**​ > ​**\[Teams (チーム)\]**​ に移動します。 2. **\[AEH Portal Guests (AEH ポータルゲスト)\]**​ をクリックし、​**\[AEH Portal Members (AEH ポータルメンバー)\]**​ をクリックします。 3. **\[External IdP Groups (外部 IdP グループ)\]**​ をクリックします。 4. **\[Group Name (グループ名)\]**​ に​**「AEH Members」**​ (AEH メンバー) と入力します。 5. **\[Provider Name (プロバイダー名)\]**​ で、対応する Salesforce ID プロバイダーの名前を選択します。 6. **\[Type (種別)\]**​ で ​**\[Member (メンバー)\]**​ を選択し、​**\[Add (追加)\]**​ をクリックします。 ## [](#auth-provider-default-scopes-認証プロバイダーのデフォルトスコープ-項目が正しく設定されていない)\[Auth Provider Default Scopes (認証プロバイダーのデフォルトスコープ)\] 項目が正しく設定されていない この問題をトラブルシューティングするには、​**\[Default Scopes (デフォルトスコープ)\]**​ 項目に ​**\[profile openid email groups (プロファイルの openid メールグループ)\]**​ 値が設定されていることを確認します。 1. **Salesforce**​ で ​**\[設定\]**​ に移動します。 2. **\[クイック検索\]**​ ボックスに​`「認証」`​と入力し、​**\[認証プロバイダー\]**​ を選択します。 3. **\[編集\]**​ をクリックします。 4. **\[認証プロバイダーの詳細\]**​ セクションで、「​`**profile openid email groups**`​」 (プロファイルの openid メールグループ) と入力します。 5. **\[保存\]**​ をクリックします。 ## [](#ログインできない)ログインできない ID プロバイダーを使用してポータルにログインしようとしたときに、​**\[ログイン中に問題が発生しました\]**​ エラーが表示され、サードパーティ ID が見つからないことが示されます。ポータル URL が正しくないと、ログインで問題が発生する可能性があります。 この問題をトラブルシューティングするには、URL が正しく設定されていることを確認します。Okta の場合、URL パスの ​`/userinfo`​ 部分は小文字にする必要があります。 # トラブルシューティング エラーが発生した場合は、次の回復手順を参照してください。 ## [](#ポータルの作成時にアップロードされた画像がビルダープレビューで表示されない)ポータルの作成時にアップロードされた画像がビルダープレビューで表示されない 共有ユーザーはどのライブラリのメンバーでもないため、ビルダープレビューでは、ポータルの作成時にアップロードされた画像を表示できません。 共有ユーザーをアセットライブラリのメンバーとして追加する手順は、次のとおりです。 1. システム管理者として Salesforce 組織にログインします。 2. **\[アプリケーションランチャー\]**​ をクリックし、検索ボックスに​**「ファイル」**​と入力して、​**\[ファイル\]**​ を選択します。 3. ナビゲーションペインで ​**\[ライブラリ\]**​ をクリックします。 4. リスト内の ​**\[アセットライブラリ\]**​ をクリックします。 5. **\[メンバーの管理\]**​ をクリックします。 **\[ライブラリメンバーを管理\]**​ 画面が開きます。 6. **\[メンバーの追加\]**​ 項目で、スタックアイコンの横にある下矢印をクリックし、​**\[人\]**​ を選択します。 **\[メンバーの追加\]**​ 項目に、​**\[人を検索\]**​ ボックスが表示されます。 7. **\[人を検索\]**​ ボックスをクリックし、​**\[ビルダープレビュー\]**​ を選択します。 8. **\[アクセス\]**​ 項目で ​**\[著者\]**​ を選択します。 9. **\[追加\]**​ をクリックして、ビルダープレビューユーザーが後で使用するためにビルダーで画像をアップロードできるようにします。 **\[現在のメンバー\]**​ セクションに、​**\[ビルダープレビュー\]**​ メンバーと ​**\[著者\]**​ アクセス権が表示されます。 10. 画面を閉じます。 11. ビルダープレビューユーザーがビルダーでライブラリ画像を表示できることを確認します。 12. 画像が表示されない場合は、ページを再読み込みします。 ## [](#api-experience-hub-が-anypoint-platform-のランディングページに表示されない)API Experience Hub が Anypoint Platform のランディングページに表示されない API Experience Hub が Anypoint Platform のランディングページに表示されない場合は、メイン組織を使用していることを確認してください。MuleSoft 管理者に連絡してエンタイトルメントが有効になっていることを確認してください。 ## [](#relax-ip-restrictions-ip-制限の緩和-オプションを変更する際にエラーが発生する)\[Relax IP Restrictions (IP 制限の緩和)\] オプションを変更する際にエラーが発生する このリリースでは、接続アプリケーションの IP 制限はサポートされません。デフォルトでは、\[IP Restrictions (IP 制限)\] 項目は ​`[Relax IP Restrictions (IP 制限の緩和)]`​ に設定されています。組織で信頼済み IP 範囲が設定されている場合、接続アプリケーションによってバイパスされます。エラーを回避するには、​**\[IP Restrictions (IP 制限)\]**​ 項目を ​`[Relax IP Restrictions (IP 制限の緩和)]`​ から変更しないでください。変更すると、ポータルの作成時にエラーが発生します。 ## [](#オブジェクトで入力規則がアクティブ化されている場合にポータルに対する変更を保存する際にエラーが発生する)オブジェクトで入力規則がアクティブ化されている場合にポータルに対する変更を保存する際にエラーが発生する オブジェクトで Salesforce リンクプロセス中に作成される標準オブジェクトに適用される入力規則がある場合、ポータルに対するスタイリングの変更を保存する際にエラーが発生します。 Salesforce リンクプロセス中に作成される取引先オブジェクトやユーザーオブジェクトなどの Salesforce 標準オブジェクトには、入力規則を適用できません。 回避策としては、リンクプロセスを実行する Salesforce ユーザーの入力規則をバイパスします。このユーザーがリンクプロセスを実行するには、システム管理者プロファイルが必要です。
これらの手順は、取引先オブジェクト入力規則のバイパスに関するものですが、他のオブジェクトのカスタム入力規則のバイパスにも適用できます。新しい権限セットを作成する代わりに、既存の権限セットを使用することもできます。
1. カスタム権限を作成します。 1. Salesforce から ​**\[設定\]**​ に移動し、​**\[クイック検索\]**​ ボックスに​**「カスタム権限」**​と入力して、​**\[カスタム権限\]**​ を選択します。 2. **\[新規\]**​ をクリックして、権限情報を入力します。 - **表示ラベル** **「Bypass Account Validation Rule」**​ (取引先入力規則をバイパス) と入力します。 - **名前**​ 項目をクリックして、アンダースコア付きの表示ラベル名を入力します。 - **説明** 権限の説明を入力します。 3. **\[保存\]**​ をクリックします。 2. 権限セットを作成して、カスタム権限を追加します。 1. **\[設定\]**​ の ​**\[クイック検索\]**​ ボックスに​**「権限セット」**​と入力し、​**\[権限セット\]**​ をクリックします。 2. **\[新規\]**​ をクリックして、権限セット情報を入力します。 - **表示ラベル** **「Bypass Account Validation Rule」**​ (取引先入力規則をバイパス) と入力します。 - **名前**​ 項目をクリックして、アンダースコア付きの表示ラベル名を入力します。 3. **\[保存\]**​ をクリックします。 4. **\[Bypass Account Validation Rule (取引先入力規則をバイパス)\]**​ をクリックし、​**\[アプリケーション\]**​ セクションから ​**\[カスタム権限\]**​ を選択します。 5. **\[使用可能なカスタム権限\]**​ から ​**\[Bypass Account Validation Rule (取引先入力規則をバイパス)\]**​ を選択し、​**\[追加\]**​ をクリックして、​**\[保存\]**​ をクリックします。 6. **\[カスタム権限\]**​ リストから、​**\[Bypass Account Validation Rule (取引先入力規則をバイパス)\]**​ を選択して ​**\[保存\]**​ を選択します。 7. **\[オブジェクトマネージャー\]**​ から、​**\[入力規則\]**​ を選択します。 8. 入力規則に使用するオブジェクトを選択して、​**\[編集\]**​ をクリックします。 9. **\[エラー条件数式\]**​ ボックスに、以下を入力します。 AND ( NOT($Permission.Bypass\_Account\_Validation), ISBLANK (Website) ) 10. **\[保存\]**​ をクリックします。 3. リンクプロセスを実行するユーザーに権限セットを割り当てます。 1. **\[設定\]**​ の ​**\[クイック検索\]**​ ボックスに​**「権限セット」**​と入力し、​**\[権限セット\]**​ をクリックします。 2. **\[Bypass Account Validation Rule (取引先入力規則をバイパス)\]**​ をクリックして、​**\[割り当ての管理\]**​ をクリックします。 3. **\[割り当てを追加\]**​ をクリックし、ユーザーを選択して ​**\[次へ\]**​ をクリックします。 4. **\[割り当て\]**​ をクリックします。 5. バイパス権限セットが設定されたユーザーを使用して、Salesforce リンクプロセスを実行します。 ## [](#接続プロセス中にパッケージをインストールする際にエラーが発生する)接続プロセス中にパッケージをインストールする際にエラーが発生する Salesforce プロセスへの接続中にパッケージをインストールする際にエラーが発生した場合は、デプロイメントの状況に関する詳細を確認できます。 1. Salesforce で ​**\[設定\]**​ に移動します。 2. **\[環境\]**​ をクリックします。 3. **\[リリース\]**​ をクリックします。 4. **\[リリース状況\]**​ をクリックします。 5. **\[失敗\]**​ セクションと ​**\[成功\]**​ セクションを確認します。 ## [](#リンクプロセスが失敗する)リンクプロセスが失敗する リンクプロセスを実行するユーザーがビジネスグループ内で Exchange コントリビュータロールを持ち、このユーザーがその同じビジネスグループ内で「システム管理者」権限を持たない場合、リンクプロセスが失敗します。 この問題を解決するには、ビジネスグループで Salesforce リンクを実行するユーザーに組織のシステム管理者権限を追加します。 ## [](#salesforce-experience-cloud-からメールが届かない)Salesforce Experience Cloud からメールが届かない Salesforce Experience Cloud からのメールが届かない場合は、次の手順に従って標準設定を無効にしてください。 1. **\[設定\]**​ > ​**\[送信\]**​ > ​**\[メールセキュリティ準拠\]**​ に移動します。 2. **\[標準メールセキュリティのメカニズムへの準拠を有効化\]**​ を選択解除します。 ## [](#mulesoft-サポートへのお問い合わせ)MuleSoft サポートへのお問い合わせ プロフェッショナルサービスのカスタマイズ、機能強化の依頼、その他のヘルプについては、MuleSoft カスタマーサクセス担当者にお問い合わせください。 API Experience Hub の問題や欠陥を報告するには、 [MuleSoft サポートポータル](https://help.mulesoft.com)​からサポートケースを送信してください。 MuleSoft サポートチームは、Salesforce サポートチームと緊密に連携して Salesforce テクノロジーに関するサポートチケットの処理を調整します。 サポートのサービスレベル契約 (SLA) については、 [「MuleSoft Product Support and Maintenance Terms (MuleSoft 製品のサポートおよびメンテナンス条件)」](https://www.mulesoft.com/legal/support-maintenance-terms?_gl=1*9coixf*_ga*MTc1Mzc4OTg5Mi4xNjc3ODY5OTkw*_ga_HQLG2N93Q1*MTY4NTk5MDc4My4yNDAuMS4xNjg1OTkwODE0LjAuMC4w)​を参照してください。 # ビルダーを使用した一般的なカスタマイズの実現 ビルダーから、次のポータルカスタマイズを使用して会社のブランドに合わせます。 **\[Manage your API Portal (API Portal を管理)\]**​ ページから、​**\[Preview and publish your portal (ポータルをプレビューしてパブリッシュ)\]**​ をクリックしてビルダーにアクセスします。 ## [](#ポータルコンポーネント追加および削除する)ポータルコンポーネント追加および削除する ビルダーから、ポータルで API Experience Hub コンポーネントを追加または削除します。 1. ビルダーに移動します。 2. **\[コンポーネント\]**​ アイコンをクリックします。 3. **\[カスタムコンポーネント\]**​ までスクロールします。 4. コンポーネント (API Console など) をクリックし、ポータルにドラッグします。 5. コンポーネントを削除するには、ゴミ箱アイコンをクリックして ​**\[Delete (削除)\]**​ をクリックします。 ### [](#各-api-種別の色をカスタマイズする)各 API 種別の色をカスタマイズする **\[Home (ホーム)\]**​ ページに表示される各 API 種別の色をカスタマイズする手順は、次のとおりです。 1. ビルダーに移動します。 2. **\[ビルダー\]**​ アイコンをクリックします。 3. **\[設定\]**​ アイコンをクリックします。 4. **\[詳細\]**​ をクリックします。 5. **\[ヘッドマークアップを編集\]**​ をクリックします。 以下に、アセットタイプの色の変数を示します。 \--asset-type-c-rest-api-color: 0, 0, 0; --asset-type-c-http-api-color: 0, 0, 0; --asset-type-c-soap-api-color: 0, 0, 0; --asset-type-c-evented-api-color: 0, 0, 0; 6. アセットタイプの色の変数の数値を変更し、​**\[保存\]**​ をクリックします。 ## [](#ログインページの背景色を変更する)ログインページの背景色を変更する ポータルのログインページの背景色を変更する手順は、次のとおりです。 1. ビルダーに移動します。 2. **\[ページのプロパティ\]**​ アイコンをクリックし、​**\[ログイン\]**​ をクリックします。 ビルダーに現在のログインページが表示されます。 3. **\[テーマ\]**​ ペイントブラシアイコンをクリックします。 4. **\[テーマ\]**​ で ​**\[色\]**​ をクリックします。 5. **\[ログインページ\]**​ セクションで、​**\[背景色\]**​ カラーピッカーから色を選択します。 ログインページの背景色が選択した色に変更されます。 ## [](#ログインページのカード背景色を変更する)ログインページのカード背景色を変更する ログインページカードのカード背景色を変更する手順は、次のとおりです。 1. ビルダーに移動します。 2. **\[ページのプロパティ\]**​ アイコンをクリックし、​**\[ログイン\]**​ をクリックします。 ビルダーに現在のログインページが表示されます。 3. **\[テーマ\]**​ ペイントブラシアイコンをクリックします。 4. **\[テーマ\]**​ で ​**\[色\]**​ をクリックします。 5. **\[ログインページ\]**​ セクションで、​**\[カードの背景色\]**​ カラーピッカーから色を選択します。 ログインページのカードの背景色が選択した色に変更されます。 ## [](#ポータル登録用のメールテンプレートを変更する)ポータル登録用のメールテンプレートを変更する サイトに登録するユーザーに送信されるメールの情報を編集する手順は、次のとおりです。 1. ビルダーに移動します。 2. **\[ビルダー\]**​ アイコンをクリックします。 3. **\[私のワークスペース\]**​ で ​**\[管理\]**​ をクリックします。 4. **\[メール\]**​ をクリックします。 5. 変更を加えて ​**\[保存\]**​ をクリックします。 ## [](#セルフ登録ページとログインページのロゴ画像を変更する)セルフ登録ページとログインページのロゴ画像を変更する デフォルトでは、ログインページに使用されるロゴ画像は、ガイド付きスタイリングセットアップ中に追加される画像です。ログインページ用の画像を変更する手順は、次のとおりです。 1. ビルダーに移動します。 2. **\[ビルダー\]**​ アイコンをクリックします。 3. **\[私のワークスペース\]**​ で ​**\[管理\]**​ をクリックします。 4. **\[ログイン & 登録\]**​ を選択します。 5. **\[ブランド設定オプション\]**​ セクションで、​**\[ロゴファイル\]**​ から ​**\[ファイルを選択\]**​ ボタンをクリックします。 ロゴの最大の高さは 125 px、最大の幅は 250 px です。 ## [](#ポータルドメインをカスタマイズする)ポータルドメインをカスタマイズする デフォルトでは、Experience Cloud によってポータルドメインの URL が生成されます。組織のドメインをカスタマイズできます。たとえば、URL を .com に変更できます。現在、URL 内のポータルのサブパス ​`aeh`​ は変更できません。 1. ビルダーに移動します。 2. **\[ビルダー\]**​ アイコンをクリックします。 3. **Salesforce の \[設定\]**​ をクリックします。 4. **\[クイック検索\]**​ ボックスに​**「ドメイン」**​と入力します。 5. **\[ドメイン\]**​ リストでドメイン名をクリックします。 6. **\[\[私のドメイン\] の詳細\]**​ セクションで ​**\[編集\]**​ をクリックします。 7. **\[\[私のドメイン\] の名前\]**​ 項目にドメイン名を入力します。 8. **\[使用可能か調べる\]**​ ボタンをクリックして、ドメイン名がまだ存在していないことを確認します。 9. **\[ドメインサフィックス\]**​ 項目にドメインサフィックスを入力します (たとえば、\*.)。 新しいドメイン URL が ​**\[選択された新しい \[私のドメイン\] の URI\]**​ 項目に表示されます。 10. **\[保存\]**​ をクリックします。 ## [](#フィードコンポーネントを設定する)フィードコンポーネントを設定する フィードコンポーネントには、すべてのレコードまたはグループのやりとりのフィード (投稿、質問、システム更新、添付ファイルを含む) が表示されます。 次のプロパティの値を指定します。

プロパティ

詳細

フィード種別

  • [グループまたはレコード]​ には、取引先や商談など、選択したグループまたはレコードに投稿されたすべてが表示されます。

  • [ディスカッション]​ フィードには、​[ナビゲーショントピック]​ に投稿されたすべてが表示されます。

  • [私のフィード]​ には、個人サイトのアクティビティと共にフォローしているトピック、人、またはレコードでタグ付けされたフィード項目が表示されます。別のユーザーが自分がメンバーではないグループと項目を共有していない限り、すべての共有フィード項目が表示されます。公開グループでは、自分がメンバーでない場合でも、共有したフィード項目が表示されます。

  • [トピック]​ フィードには、選択したトピックに投稿されたすべてが表示されます。

  • [ユーザープロファイル]​ フィードには、ユーザープロファイルフィードに投稿されたコメントや回答など、メンバーが作成またはやりとりした投稿が表示されます。

  • [ブックマーク]​ フィードには、選択したブックマークに対して投稿されたブックマーク済み投稿、プール、または質問のみが表示されます。

レコード ID

[フィード種別]​ で ​[ディスカッション]​ または ​[私のフィード]​ オプションを選択した場合は、この項目を空白のままにしておきます。通常この項目には、ページの読み込み時にフィード項目 ID が自動的に入力されます。

デフォルトの検索条件

サイトメンバーに表示するフィードエントリのデフォルト検索条件を選択します。

投稿スタイル

デフォルトで投稿コメントを展開するか折りたたむかを選択します。

メンバーによるフィードの検索を許可

サイトメンバーに個々のフィードの検索を許可する場合に選択します。

メンバーによるフィードの並び替えを許可

サイトメンバーにフィードの並び替えを許可する場合に選択します。並び替えが有効になっている場合、メンバーは最新の投稿または最新の活動によってフィードを並び替えることができます。

## [](#フィードパブリッシャーコンポーネントを設定する)フィードパブリッシャーコンポーネントを設定する ポータルメンバーがグループまたはレコードへの投稿を作成し、添付ファイルをアップロードできるようにするには、Chatter フィードパブリッシャーコンポーネントを設定します。 次のプロパティの値を指定します。

プロパティ

詳細

種別

プロジェクトに追加するフィードパブリッシャーを選択します。Salesforce 組織で定義されたグローバルパブリッシャーアクションを使用するには、​[グローバル]​ を選択します。オブジェクト固有のパブリッシャーレイアウトを使用するには、​[レコード]​ を選択します。

レコード ID

[グローバル]​ フィードパブリッシャー種別を選択する場合は、この項目を空白のままにしておきます。通常この項目には、ページの読み込み時にレコード ID が自動的に入力されます。

パブリッシャーレイアウトのデザイン

幅が広いまたは狭いフィードパブリッシャーレイアウトのデザインを表示する場合に選択します。

## [](#関連情報)関連情報 - [エクスペリエンスビルダーを使用したポータルのカスタマイズ](https://docs.mulesoft.com/jp/api-experience-hub/customizing-your-portal) - [CSS を使用した高度なスタイリング](https://docs.mulesoft.com/jp/api-experience-hub/advanced-styling-with-css) # ベストプラクティス API の適応性は、よくまとめられたドキュメントおよびメンテナンスに大きく左右されます。API 戦略をしっかり練ってください。 パフォーマンスや体験を最適にするには、MuleSoft が推奨する次のベストプラクティスに従ってください。 - [API 開発のベストプラクティス - MuleSoft](https://www.mulesoft.com/resources/api/development-best-practices) - [Best Practices for Planning, Designing, and Managing APIs (API の計画、設計、管理に関するベストプラクティス)](https://blogs.mulesoft.com/dev-guides/api-design/best-practices-for-building-apis/) - [Best Practices to Design Your First API Specification (最初の API 仕様を設計するためのベストプラクティス)](https://developer.mulesoft.com/tutorials-and-howtos/getting-started/best-practices-first-api-spec/) - [API の設計と管理 - MuleSoft](https://www.mulesoft.com/lp/whitepaper/api/design-apis) # ポータルでのシングルサインオンの有効化 システム管理者またはセキュリティチームは、API Experience Hub ポータルのログインオプションとして外部 ID プロバイダー (IdP) を実装できます。シングルサインオン (SSO) 認証は、組織の独自のブランドを使用して顧客にシームレスなログイン環境を提供します。ユーザーは、別のユーザー名とパスワードを覚えたり、ログイン情報を何度も入力したりすることなく、ポータルにログインできます。 ポータルのメンバーがポータルページにアクセスして SSO オプションを選択すると、認証のために ID プロバイダーのログインページにリダイレクトされます。SSO 認証プロセスでは、ID プロバイダーを使用してユーザーの ID を確認します。ログインが成功すると、ユーザープロファイルと一致するユーザーがアクセス管理内に作成されます。ユーザーが API を参照および検出するための API Experience Hub ポータルホームページが表示されます。 アクセス管理により、Anypoint Platform の SSO の ID 管理が設定されます。ID プロバイダーについての詳細は、アクセス管理の [「ID 管理」](https://docs.mulesoft.com/access-management/external-identity)​を参照してください。 ポータルの SSO の設定には、次の概要手順が含まれます。これらの手順は、ユースケースによって異なる場合があります。 - ステップ 1 - ポータルの SSO を有効にする このステップでは、ID プロバイダーでアプリケーションを作成して設定します。 - ステップ 2: Salesforce ID プロバイダーを追加する このステップでは、API Experience Hub UI から Salesforce ID プロバイダーを追加して有効にします。ID プロバイダーが有効になると、ユーザーはポータルのログインページからログインオプションを確認できます。 - ステップ 3: グループマッピングを追加する このステップでは、追加した Salesforce ID プロバイダーで作成したグループを、ポータルの対応するチームプロファイルにマップします。 - ステップ 4: SSO 設定をテストする このステップでは、ポータル用にセットアップした SSO 設定をテストします。 ![SSO の有効化フローチャート](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-sso-flow2.png) ## [](#username-strategy)ユーザー名の割り当て戦略 ポータルの SSO ログインオプションをセットアップし、Anypoint Platform 組織で ID プロバイダーがすでに設定されている場合、ポータルユーザーと Anypoint Platform ユーザーではユーザー名の割り当て戦略が異なる可能性があるため、セキュリティチームがユーザー名の割り当て戦略を検討する必要があります。ポータルと Anypoint Platform 間で 1 つの ID を設定するには、ユーザー名の割り当ての形式が同じである必要があります。ユーザー名戦略が一致しない場合、​**anypoint\_idp\_id**​ と ​**anypoint\_username**​ の属性を追加して、ユーザー名の形式を調整する必要があります。その後、SSO に使用している Anypoint Platform ID プロバイダーにこの情報をマップする必要があります。これらのカスタム属性は、ID プロバイダーのプロファイルエディターを使用して追加されます。詳細は、​[「Anypoint Platform 用にすでに設定されている ID プロバイダーを使用する SSO の設定」](https://docs.mulesoft.com/jp/api-experience-hub/sso-use-case-2)​を参照してください。 ## [](#ユーザーロール)ユーザーロール API Experience Hub の ID プロバイダーのセットアップには、さまざまなユーザーアクションを実行する複数のペルソナが含まれます。 組織のセットアップに応じて、次の 1 つ以上のロールをユーザーに割り当てることができます。 - API Experience Hub Administrator (API Experience Hub 管理者) AEH 管理者は、API EXperience Hub UI で ID プロバイダーを有効または無効にします。 Salesforce システム管理者 Salesforce システム管理者は、Salesforce で ID プロバイダーをセットアップします。 - Anypoint 組織のシステム管理者 Anypoint 組織のシステム管理者は、アクセス管理チームのグループマッピング機能を使用して、ID プロバイダーグループを API Experience Hub プロファイルにマップします。 - セキュリティチーム 組織のセキュリティチームは、必要なユーザーグループとアプリケーションを使用して ID プロバイダーをセットアップします。組織のセキュリティチームと組織の ID プロバイダーシステムを管理する Salesforce システム管理者は、Salesforce で適切なログインオプションを設定します。メイン組織のセキュリティチームと組織のシステム管理者は、必要に応じて、Anypoint Platform で同じ ID プロバイダーオプションを設定できます。メイン組織のセキュリティチームと組織のシステム管理者は、Salesforce と Anypoint Platform 間のマッピングを設定します。アクセス管理では、チームを使用して外部 ID プロバイダーのグループマッピングを追加する機能が提供されます。グループマッピングが適切に設定されている場合、ポータルにログインするユーザーは、そのユーザーが属する標準のプロファイルに自動的に追加されます。デフォルトの ID プロバイダーは、Salesforce ユーザー向けに Anypoint Platform で ID を作成するために提供されています。 Anypoint Platform と Salesforce の ID プロバイダーは、OpenID Connect または SAML (シングルサインオン設定) を使用して設定できます。 ## [](#out-of-the-box-configurations)標準の設定 API Experience Hub には、SSO を有効にするプロセスを支援する次の標準の設定が用意されています。 - anypoint\_idp\_id カスタムクレームまたは SAML 属性は、ユーザーをマップする必要がある Anypoint Platform ID プロバイダーを決定する ID プロバイダーから受け取る情報を提供します。 - AEH Users (AEH ユーザー) - ${salesforceOrganizationId} すべてのセルフ登録ユーザーをマップするために Anypoint Platform で作成されるデフォルトの Anypoint Experience Hub ID プロバイダー。この ID プロバイダーは、ID プロバイダーで aeh\_portal\_idp が設定されていない場合に使用されます。セルフ登録ユーザーは、デフォルトの ID プロバイダーにマップされます。 - AEH Portal (AEH ポータル) - ${salesforceOrganizationId}\_$\*{salesforceCommunityId} このソリューションでは、アクセス管理に AEH Portal (AEH ポータル) というチームが自動的に作成されます。このチームには、システム管理者、ゲスト、メンバーのプロファイルが含まれます。グループマッピングを追加するときにこのチームを選択します。 - AEHPortalRegistrationHandler.cls API Experience Hub パッケージには、SAML および OpenID Connect と互換性のある AEHPortalRegistrationHandler.cls という 1 つの Apex クラスがあります。 登録ハンドラーは、ユーザーが Salesforce Experience Cloud サイトにログインしたときに実行される Apex コードです。Salesforce の認証プロバイダーを設定するときに、このハンドラーを選択します。ID プロバイダーが適切に設定されている場合、Salesforce はポータル ID を AEHPortalRegistrationHandler に渡します。ユーザーが存在しない場合、登録ハンドラーによって Salesforce にユーザーの ID が作成されます。ユーザーが存在する場合、ハンドラーは ID プロバイダーから送信された情報 (ユーザーの姓名など) に基づいてユーザーのメタデータを更新します。ポータルで特定の設定を読み込むため、登録ハンドラーは Salesforce のポータル ID を使用します。たとえば、登録ハンドラーは NetworkSelfRegistration オブジェクトからポータルに関連するプロファイルとアカウントでユーザーを作成します。 ## [](#基本用語)基本用語 このトピックでは次の用語が参照されています。 認証プロバイダー 認証プロバイダーは、プロトコルに応じて、承認されたデータアクセス、認証、またはその両方のために Salesforce をサードパーティに接続できるようにするフレームワークです。認証プロバイダーは OAuth 2.0 を実装して、Salesforce がサードパーティデータにアクセスすることを承認できます。または、OpenID Connect やカスタム認証プロトコルを実装して、サードパーティのデータアクセスと認証の両方をサポートすることもできます。 認証プロバイダーを使用している場合、Salesforce は常に証明書利用者となります。認証プロバイダーが OpenID Connect を実装している場合、サードパーティは OpenID プロバイダーと呼ばれます。カスタム認証プロトコルを実装している場合、サードパーティは ID プロバイダーと呼ばれます。 ID プロバイダー ID プロバイダーは、ユーザーの ID を認証する信頼できるサービスとして機能します。 OpenID Connect OpenID Connect は、OAuth 2.0 に基づいて構築されたオープン標準の認証プロトコルです。OpenID Connect を使用すると、証明書利用者と OpenID プロバイダーはユーザーが誰であるか、ユーザーはサービスで何をできるかについての情報を交換できます。 OpenID プロバイダー OpenID Connect では、ID プロバイダーは OpenID プロバイダーと呼ばれます。証明書利用者の要求に応じてユーザーを認証します。 証明書利用者 OpenID Connect およびカスタム認証プロトコルでは、サービスプロバイダーは証明書利用者と呼ばれますが、この 2 つの用語は言い換えて使用される場合もあります。認証は OpenID プロバイダーまたは ID プロバイダーに依存します。 Security Assertion Markup Language (SAML) SAML は、Salesforce 組織に SSO を実装するために使用できるオープン標準の認証プロトコルです。SAML を使用すると、ID プロバイダーとサービスプロバイダーがユーザー情報を安全に交換できるようになり、サービス間のユーザー認証が可能になります。 シングルサインオン シングルサインオン (SSO) は、ユーザーが 1 回のログインと 1 セットのログイン情報で複数のアプリケーションにアクセスできるようにする認証方法です。たとえば、ユーザーは組織にログインした後に、アプリケーションランチャーからすべてのアプリケーションに自動的にアクセスできます。サードパーティの ID プロバイダーを信頼してユーザーを認証するように Salesforce または Anypoint Platform 組織をセットアップできます。または、認証は組織に依存するようにサードパーティアプリケーションを設定することもできます。 ## [](#before-you-begin)始める前に SSO を有効にする前に、次の権限とコンテキストがあることを確認してください。 - Anypoint Platform メイン組織での「Organization Administrator (組織のシステム管理者)」権限またはロール。 - Salesforce でのシステム管理者ロール。 - ID 管理と SSO 用の ID プロバイダーのセットアップの経験。 - Anypoint Platform の ID 管理を理解するには、アクセス管理の​[「ID プロバイダー」](https://docs.mulesoft.com/jp/access-management/external-identity)​ドキュメントを参照してください。 - ID プロバイダーでポータルの新しいアプリケーションを作成する場合、API Experience Hub で必要とされるクレームまたは属性に注意してください。 ID プロバイダーで必須のユーザークレームを設定することで、ユーザー情報が Salesforce および Anypoint ユーザーに正しくマップされます。 AEHPortalRegistrationHandler では、ユーザーを作成または更新するために ID プロバイダーからの特定のユーザー情報が必要です。必須のクレームは、ユーザー情報を抽出するために登録ハンドラーによって使用されます。次の表は、必要な情報と、その情報がどのクレームから抽出されるかを示しています。同じ値に対して複数のクレームがある場合、登録ハンドラーは次の表に示されている順序で最初の予期されるクレームを検索します。
項目 予期されるクレーム

First Name (名)

given_name、first_name、firstname、firstName

Last Name (姓)

family_name、last_name、lastname、lastName

Email (メール)

email、email_address、emailAddress

Username (ユーザー名)

preferred_username、federation_identifier、email、sub、NameId

Groups (グループ)

グループ

[ID プロバイダーが Anypoint Platform 用にすでに設定されている場合の SSO の設定](https://docs.mulesoft.com/jp/api-experience-hub/sso-use-case-2)などの特定のユースケースを設定するには、次の情報を使用します。
項目 説明 使用できる値

Anypoint Idp ID

ID を Anypoint Platform の特定の ID プロバイダーにマップします。

anypoint_idp_id

Anypoint Username (Anypoint ユーザー名)

ユーザーの ID が Anypoint Platform にすでに存在し、ユーザー名が Salesforce ユーザーとは異なる場合は、Anypoint Platform ユーザーを明示的に指定します。

anypoint_username

必要な情報がサポートされる形式ではない場合、サポートされる形式で新しいカスタム属性またはクレームを作成します。詳細は、ID プロバイダーのドキュメントを参照してください。 ## [](#ポータルのシングルサインオンのユースケース)ポータルのシングルサインオンのユースケース ポータルの SSO の設定に役立つ次のユースケースが提供されています。 - [Anypoint Platform で ID プロバイダーが設定されていない場合の SSO の設定](https://docs.mulesoft.com/jp/api-experience-hub/sso-use-case-1) - [ID プロバイダーが Anypoint Platform 用にすでに設定されている場合の SSO の設定](https://docs.mulesoft.com/jp/api-experience-hub/sso-use-case-2) これらのユースケースは、SSO を有効にする方法の例として ID プロバイダーとして Okta を使用してドキュメント化されていますが、任意の ID プロバイダーを使用できます。 ## [](#関連情報)関連情報 - [シングルサインオンエラーのトラブルシューティング](https://docs.mulesoft.com/jp/api-experience-hub/troubleshoot-sso-errors) - [ユーザーの管理](https://docs.mulesoft.com/jp/api-experience-hub/managing-users) # ポータルにアクセスするための登録 ログインせずに API Portal にアクセスしているユーザーは、使用するために API へのアクセス権を要求するなど、ポータルのほとんどのアクションを実行できません。メンバーになると、より多くの API や機能にアクセスできるようになります。誰でもアカウントに登録してメンバーになることができます。登録すると、アカウントとパスワードを設定するためのリンクが記載された歓迎メールが API Experience Hub によって送信されます。 アカウントに登録する手順は、次のとおりです。 1. ブラウザーウィンドウに、ポータルの URL を入力します。 2. **\[Log in (ログイン)\]**​ をクリックします。 3. **\[Not a Member? (メンバーではありませんか?)\]**​ をクリックします。 4. 名、姓、メールアドレスを入力します。 5. **\[Sign Up (サインアップ)\]**​ をクリックします。 6. 歓迎メールの手順に従ってアカウントをセットアップします。 ## [](#関連情報)関連情報 - [API の検出](https://docs.mulesoft.com/jp/api-experience-hub/discovering-apis) - [API の検索](https://docs.mulesoft.com/jp/api-experience-hub/searching-for-apis) # ポータルのプレビュー ポータルに変更を加えたら、\[Manage your API (API を管理)\] ページまたはビルダーから新しいバージョンをプレビューして期待どおりであることを確認できます。 1. **\[Manage your portal (ポータルを管理)\]**​ ページで、​**\[Preview and publish your portal (ポータルをプレビューしてパブリッシュ)\]**​ をクリックします。 2. 変更が適用され、適切に表示されることを確認します。 管理者のみに表示される API は、このプレビューに表示されます。 3. ポータルをパブリッシュするには、​**\[Publish (パブリッシュ)\]**​ をクリックします。 4. 変更を行うには、​**\[Back to Builder (ビルダーに戻る)\]**​ をクリックします。 ## [](#関連情報)関連情報 - [ビルダーを使用したポータルのカスタマイズ](https://docs.mulesoft.com/jp/api-experience-hub/customizing-your-portal) # ポータルのプレビューとパブリッシュ ポータルの管理と選定後、ビルダーで変更をプレビューし、ユーザーにパブリッシュできます。ポータルの URL は、ポータルをパブリッシュするまでアクセスできません。サイトを初めてパブリッシュすると、ポータル URL が公開され、ログインアクセスが可能になります。 ポータルをプレビューしてパブリッシュする手順は、次のとおりです。 1. **\[Manage your API portal (API Portal を管理)\]**​ ページで、​**\[Preview and publish your portal (ポータルをプレビューしてパブリッシュ)\]**​ をクリックします。 2. 変更を確認して、​**\[Publish (パブリッシュ)\]**​ をクリックします。 変更が公開されると確認メールが届きます。メールにはパブリッシュしたサイトへの URL リンクが記載されています。 ## [](#公開されているパブリッシュ済みポータルの-url-を表示する)公開されているパブリッシュ済みポータルの URL を表示する 公開されているパブリッシュ済みポータルの URL を表示するには、ビルダーで ​**\[設定\]**​ > ​**\[一般\]**​ に移動します。​**\[公開済み状況\]**​ セクションに公開されているパブリッシュ済みポータルの URL が表示されます。 ## [](#関連情報)関連情報 - [ポータルのカスタマイズ](https://docs.mulesoft.com/jp/api-experience-hub/customizing-your-portal) - [API の検出とコンシューム](https://docs.mulesoft.com/jp/api-experience-hub/discovering-and-consuming-apis) # ポータルの切断 Anypoint は 1 つの Salesforce 組織のみに接続でき、その組織用に 1 つの API Portal のみを作成できます。ポータルが不要になった場合や、同じ Salesforce 組織を使用して新しいポータルを作成する場合、ポータル管理者はポータルを切断できます。 API Portal を切断すると、API Experience Hub データベースからアーティファクトが削除され、Anypoint が Salesforce 組織からリンク解除されるため、別の API Portal を作成できるようになります。 新しい API Portal を作成するには、Salesforce 組織から現在の API Portal を切断する必要があります。このプロセスにより、Salesforce 組織から Anypoint が切断されます。その後、Anypoint アカウントを新しい Salesforce 組織にリンクできます。 切断する手順は、次のとおりです。 1. **\[Manage your API Portal (API Portal を管理)\]**​ ページで、​**\[Settings (設定)\]**​ をクリックします。 2. **\[Disconnect Salesforce Org (Salesforce 組織を切断)\]**​ をクリックします。 3. 切断するには、メッセージで ​**\[Disconnect Salesforce Org (Salesforce 組織を切断)\]**​ をクリックします。 ## [](#関連情報)関連情報 - [Salesforce への接続](https://docs.mulesoft.com/jp/api-experience-hub/connecting-to-salesforce) # ポータルの外観のカスタマイズ ビルダーでは、サイトのコンポーネント、テーマ、ページ、およびその一般プロパティ、テーマ、SEO の設定を制御して、目的のブランドアイデンティティ、外観、サイト構造の Salesforce Experience Cloud サイトを作成します。 ビルダーリンクにより、サイトが開いて編集できるようになります。ポータルの各ページを編集し、新しいページを作成し、各ページのコンポーネントを追加および編集できます。 ビルダーのインターフェースには、ページリスト、コンポーネントパレット、テーマメニュー、ページ構造メニュー、設定メニューが含まれています。 API Experience Hub は、モバイルデバイスでの使用は保証されていません。一部の機能はモバイルデバイスで動作しますが、API Console などの一部の機能は動作しません。 ## [](#ページリスト)ページリスト \[ページ\] リストには、API Experience Hub に含まれるページおよび追加したページが表示され、各ページを選択および編集できます。含まれているホームページがデフォルトで選択されています。 \[ページ\] リストでは、\[新規ページ\] オプションを使用して新規ページを作成できます。新規ページはオブジェクトページまたは標準ページのどちらかになります。オブジェクトページは Salesforce オブジェクトでのみ使用されるため、カスタムコミュニティページは標準ページとして開始されます。標準ページは、いずれかの事前設定済みのページから、または空白ページで開始できます。 新しい空白のページを作成する場合は、レイアウトを選択してから、新しいページの名前と URL を入力します。その URL は、メニューに登録されるリンクなど、新規ページへのリンクを作成するために使用します。 レイアウトに応じて、新規ページにはコンテンツのプレースホルダーが表示されます。 ページヘッダーの \[見出し\] コンポーネント、または API Experience Hub コンポーネント (\[API Version Carousel (API バージョンカルーセル)\] など) のようなコンポーネントを \[コンポーネント\] メニューから新しいページに追加します。 \[ページ\] リストには、各ページの編集可能な設定プロパティが表示されます。これらのプロパティの詳細については、 [「エクスペリエンスビルダーでのコミュニティのページとプロパティの管理」](https://help.salesforce.com/s/articleView?id=sf.community_builder_manage_pages_overview.htm&type=5)​を参照してください。 ## [](#コンポーネント)コンポーネント \[コンポーネント\] 稲妻アイコンをクリックすると、コンポーネントパレットが表示されます。このパレットには、Salesforce Experience Cloud コンポーネント (\[見出し\] や \[主要トピック\] など)、および API コミュニティマネージャーに固有のコンポーネント (\[API Carousel (API カルーセル)\] や \[API Console\] など) が含まれます。任意のコンポーネントをコンポーネントパレットから現在のページにドラッグできます。ページ内のコンポーネントを選択すると、そのコンポーネントの設定オプションが表示されます。 API Experience Hub には、次の Lightning コンポーネントがあります。 - API Console - Asset Detail Header (アセット詳細ヘッダー) - Asset Documentation Viewer (アセットドキュメントビューアー) - Assets Carousel (アセットカルーセル) - Assets Catalog (アセットカタログ) - Search Box (検索ボックス) - Search Result コンポーネントの詳細な情報については、ページと Salesforce Experience Cloud の [「コンポーネント」](https://help.salesforce.com/s/articleView?id=sf.rss_component_reference_table.htm&type=5)​ドキュメントを参照してください。各コンポーネントの説明については、​[「API Experience Hub Lightning コンポーネント」](https://docs.mulesoft.com/jp/api-experience-hub/api-experience-hub-lightning-components)​を参照してください。 ## [](#テーマ)テーマ \[テーマ\] ペイントブラシアイコンをクリックすると、次の一般的なブランディングパラメーターが表示されます。 - Colors (色) 段落、見出し、ボタンテキストなど、サイトの一般色スキームを設定します。 - 画像 サイトの会社のロゴとログインページの背景画像を指定します。 - フォント プライマリフォントと見出しのフォントを含むサイトのフォントを指定し、サイトのテキストの大文字/小文字を指定します。 - テーマの設定 CSS ルールを編集することで、コミュニティのスタイルを調整できます。\[テーマ\] タイトルの横にある \[テーマ\] リストをクリックし、\[CSS を編集\] をクリックします。 [「エクスペリエンスビルダーサイトのテーマのカスタマイズ」](https://help.salesforce.com/s/articleView?id=sf.community_builder_theme_customize.htm&type=5)​を参照してください。 ブランドセットを使用して複数のポータルをブランド設定します。詳細は、 [「エクスペリエンスビルダーでのブランドセットの使用」](https://help.salesforce.com/s/articleView?id=sf.community_designer_brandsets.htm&type=5)​を参照してください。 ## [](#ページ構造)ページ構造 箇条書きを思わせる \[ページ構造\] アイコンをクリックすると、現在のページのコンポーネントが表示され、それらを選択および削除できます。コンポーネントを選択すると、その設定メニューが表示されます。 ## [](#設定)設定 \[設定\] 歯車アイコンをクリックすると、次のパラメーターが表示されます。 - [一般](https://help.salesforce.com/articleView?id=community_builder_general_settings.htm&type=5) - [テーマ](https://help.salesforce.com/articleView?id=community_builder_theme.htm&type=5) - SEO 検索エンジン最適化 (SEO) 機能は、どの情報に対して外部サービスがインデックスを作成できて、オンライン検索で検出できるかを定義することで、公開コミュニティへのトラフィックを増やします。 詳細は、 [「エクスペリエンスビルダーの設定」](https://help.salesforce.com/s/articleView?id=sf.community_builder_general_settings.htm&type=5)​ヘルプトピックを参照してください。 ## [](#関連情報)関連情報 [API Experience Hub Lightning コンポーネント](https://docs.mulesoft.com/jp/api-experience-hub/api-experience-hub-lightning-components) # ポータルの無効化 ポータルサイトを無効化することで、パブリッシュ済みのポータルにユーザーがアクセスできないようにできます。ポータルはまだアクティブとみなされますが、アクセスはできません。引き続きビルダーを使用して変更を加え、ユーザーがアクセスできるように後でサイトを再パブリッシュできます。 ポータルサイトを無効化するには、次の手順を実行してください。 1. **\[Manage your API Portal (API Portal を管理)\]**​ ページで、​**\[Preview and publish your portal (ポータルをプレビューしてパブリッシュ)\]**​ をクリックします。 2. **\[ビルダー\]**​ アイコンをクリックします。 3. **\[私のワークスペース\]**​ で ​**\[管理\]**​ をクリックします。 4. **\[設定\]**​ をクリックします。 5. **\[無効化\]**​ をクリックします。 サイトが無効になり、オフラインになります。 サイトを有効にするには、手順 1 ~ 4 を実行して ​**\[有効\]**​ をクリックします。 ## [](#関連情報)関連情報 - [ポータルの切断](https://docs.mulesoft.com/jp/api-experience-hub/disconnecting-the-portal) # ポータルの管理 ガイド付き設計を使用してポータルをスタイル設定したら、​**\[Manage your API portal (API Portal を管理)\]**​ ページに API、ユーザー、設定、環境を管理するオプションが表示され、ポータルの管理中に発生する問題が明らかになります。 - [API 管理](https://docs.mulesoft.com/jp/api-experience-hub/managing-apis) Exchange から API Portal に API を追加し、ポータルから API を削除して、Exchange にある API のリストを表示し、API バージョンの表示を変更します。 - [ユーザー管理](https://docs.mulesoft.com/jp/api-experience-hub/managing-users) メンバーと保留中の要求を表示して管理します。 - Settings (設定) [ポータルの Salesforce アカウントに関する情報を表示](https://docs.mulesoft.com/jp/api-experience-hub/viewing-salesforce-account-information)​して、​[ポータルを切断](https://docs.mulesoft.com/jp/api-experience-hub/disconnecting-the-portal)​します。 - [環境](https://docs.mulesoft.com/jp/api-experience-hub/working-with-sandboxes) API Portal の個別のデプロイメント環境を管理します。複数の Salesforce Sandbox 組織に接続し、それらを切り替えることができます。 ## [](#api-管理ページでの問題の表示)API 管理ページでの問題の表示 API Experience Hub では、バックグラウンドで実行される診断チェックが提供され、ポータルの問題が特定されて、それらの問題が自動的に修正されたり、トラブルシューティングオプションが提供されたりします。チェックは、ページの読み込みまたは更新時、および UI でのアクションの実行時にトリガーされます。これらのチェックは、システム管理者がエラー状態を特定し、問題をトラブルシューティングするのに役立ちます。 API 管理ページで問題が検出されると、ページのバナーにメッセージが表示されます。このメッセージでは、システムが修正しようとしている問題がいくつか検出されたことが示されます。 ![検出された問題を含むバナーの例](/mulesoft/current/ja-jp/api-experience-hub/_images/error-message-banner.png) すべてのチェックとパッチを試行した後も問題が解決しない場合は、対処が必要な問題があることを示すメッセージがバナーに表示されます。これらの問題についての詳細を表示するには、​**\[View details (詳細を表示)\]**​ をクリックします。 ポータル内のページが読み込まれるか更新されるたびに、次の最小限の前提条件チェックが実行されます。 - Salesforce との接続が機能している。 - API Experience Hub パッケージが Salesforce 組織にインストールされている。 - 標準のプロファイルでアクセス管理チームが作成されている。 - 共有ユーザー (エクスペリエンスビルダープレビュー) が存在し、Salesforce にログインしてエクスペリエンスビルダーを操作するために必要なすべての権限がある。 問題には次の重要度があります。 - Error (エラー) ポータル内の 1 つまたは複数の機能の使用を妨げる問題。 - Warning (警告) 何かが期待どおりに動作していないことを示す問題ですが、その問題に対処しなくてもポータルは引き続き使用できます。 - Info (情報) 知っておくと役立つ情報ですが、ポータルの使用を妨げるものではありません。 # モッキングサービスを使用した API コールのシミュレーション API へのコールをシミュレーションするには、ポータルの API Console でモッキングサービスを使用します。モッキングサービスは、API の開発やテストの役立つシミュレーションサービスを生成できる Anypoint の機能です。これらのモックサーバーでは、要求を受け入れて応答を提供するアクションが開始されます。モッキングサービスでは、実際の API の機能が複製されます。 ## [](#始める前に)始める前に 1 つ以上のエンドポイントと 1 つのメソッドが含まれる API 仕様が必要です。 ## [](#内部-url-を使用して-api-へのコールをシミュレーションする)内部 URL を使用して API へのコールをシミュレーションする 内部 URL にアクセスするには、要求 URL の一部として認証ヘッダーを指定する必要があります。認証ヘッダーを指定せずに API をテストするには、このプロジェクト用のモッキングサービス公開 URL を生成します。モッキングサービスは、​**\[Try it (試す)\]**​ ペインで選択されたサーバーです。 1. **\[Home (ホーム)\]**​ または ​**\[APIs (API)\]**​ ページで、REST API を選択します。 2. **\[API specification (API 仕様)\]**​ タブを選択します。 3. `[GET]`​ などのメソッドをクリックします。 4. **\[Documentation (ドキュメント)\]**​ ペインで、要求および応答データを確認します。 5. **\[Try it (試す)\]**​ ペインで、テストするクエリパラメーターを入力します。 クエリパラメーターは名前と値のペアとして入力できます。 6. **\[Send (送信)\]**​ をクリックします。 API Console に、API で指定した HTTP 戻りコードが表示されます。または、要求 URL をコピーして API をテストし、Web ブラウザーまたは Postman に貼り付けることができます。 ## [](#関連情報)関連情報 - [API Console の使用](https://docs.mulesoft.com/jp/api-experience-hub/using-the-api-console) # ユーザーの管理 ユーザーの表示と管理、ゲストユーザーからの要求へのアクセス、ユーザーグループの作成と管理、ユーザーのログイン方法の管理を行います。 デフォルトでは、ユーザーはデフォルトでポータルにセルフ登録できます。 ## [](#ポータルメンバーを管理する)ポータルメンバーを管理する **\[Portal members (ポータルメンバー)\]**​ ページを使用して、ポータルメンバーを管理します。ゲストユーザーの登録が承認されると、そのユーザーの名前がメンバーリストに追加されます。現在のメンバーの検索可能なリストを表示して、有効または無効にしてユーザーグループに追加することで、そのアカウントを管理できます。 ### [](#メンバーを表示および検索する)メンバーを表示および検索する **\[Search by name or email (名前またはメールアドレスで検索)\]**​ ボックスにメンバーの名前またはメールアドレスを入力して、メンバーを検索します。 ### [](#ポータルへのアクセスを有効または無効にする)ポータルへのアクセスを有効または無効にする **\[Pending registration requests (保留中の登録要求)\]**​ ページでポータルへのユーザーのアクセスが承認されると、​**\[Enable portal access (ポータルアクセスの有効化)\]**​ スライダーが ​**\[Portal members (ポータルメンバー)\]**​ ページで有効になります。スライダーをオフに切り換えることでユーザーのアクセスを無効にします。 ### [](#メンバーをユーザーグループに割り当てる)メンバーをユーザーグループに割り当てる ユーザーをユーザーグループに割り当てて、ポータルでユーザーが表示できる API を管理します。ユーザーを複数のユーザーグループに割り当てたり、ユーザーグループを変更したりできます。 1. **\[Portal members (ポータルメンバー)\]**​ ページで、リストからメンバーの名前を見つけて、​**\[View and assign user groups (ユーザーグループを表示して割り当て)\]**​ をクリックします。 2. 1 つ以上のユーザーグループを選択し、​**\[Apply (適用)\]**​ をクリックします。 ## [](#保留中の登録要求を管理する)保留中の登録要求を管理する **\[Pending registration requests (保留中の登録要求)\]**​ ページを使用して、ポータルへのアクセスを登録したユーザーの要求を承認または拒否します。アクセスするために登録したユーザーの名前、メール、登録日、登録状況を表示できます。デフォルトでは、ユーザーは \[Members (メンバー)\] プロファイルに割り当てられます。ポータルで特定の API を表示できる選択可能なユーザーグループにユーザーを追加できます。保留中のユーザー登録要求の最大数は 500 です。 登録が承認されると、ユーザーは ​**\[Pending registration requests (保留中の登録要求)\]**​ ページのリストから削除され、​**\[Portal members (ポータルメンバー)\]**​ ページのメンバーのリストに追加されます。 登録が拒否された場合、ユーザーはリストから削除され、ログインしてポータルにアクセスできなくなります。 ### [](#メンバー登録を承認または拒否する)メンバー登録を承認または拒否する ゲストユーザーによるセルフ登録を使用したアカウントへの登録があったら、その要求を承認または拒否し、ユーザーをユーザーグループに割り当てます。セルフ登録するすべてのユーザーは、\[Members (メンバー)\] プロファイルに割り当てられます。メンバーユーザーを複数のユーザーグループに割り当てることができます。 1. **\[Pending registration requests (保留中の登録要求)\]**​ をクリックします。 2. ユーザーを検索するには、​**\[Search by name or email (名前またはメールアドレスで検索)\]**​ ボックスにユーザーの名前またはメールアドレスを入力します。 3. ユーザーグループにユーザーを割り当てます。 1. **\[Members (メンバー)\]**​ をクリックし、1 つ以上のユーザーグループを選択します。 2. **\[Apply (適用)\]**​ をクリックします。 4. **\[Approve (承認)\]**​ または ​**\[Reject (拒否)\]**​ をクリックします。 ## [](#ユーザーグループを管理する)ユーザーグループを管理する **\[User groups (ユーザーグループ)\]**​ ページを使用して、ポータルで特定の API を表示できるユーザーのグループを作成および管理します。 ユーザーグループを削除する前に、すべてのユーザー、API、およびユーザーグループに割り当てられたすべての API インスタンスの表示を削除します。 - ポータルで特定の API を表示できるユーザーのグループを作成する手順は、次のとおりです。 1. **\[User groups (ユーザーグループ)\]**​ ページで、​**\[Create user group (ユーザーグループを作成)\]**​ をクリックします。 2. グループの名前と省略可能な説明を入力します。 3. **\[Save (保存)\]**​ をクリックします。 - ユーザーグループを削除するには、​**\[User groups (ユーザーグループ)\]**​ ページでユーザーグループを選択し、​**\[Delete user group (ユーザーグループを削除)\]**​ をクリックします。 ### [](#外部-id-プロバイダーを使用してユーザーグループをマップする)外部 ID プロバイダーを使用してユーザーグループをマップする ユーザーグループのユーザーが SSO を使用してポータルにログインできるようにするには、ユーザーグループを既存の外部 ID プロバイダーにマップします。ログインの問題を回避するには、ID プロバイダー用に設定された同じグループ名と ID プロバイダー名を使用します。 API Experience Hub で対応するプロファイルにユーザーグループを追加する手順は、次のとおりです。 1. **\[User groups (ユーザーグループ)\]**​ ページから、グループを選択します。 2. **\[External IdP groups (外部 IdP グループ)\]**​ タブで、​**\[+ Add group mapping (グループマッピングを追加)\]**​ をクリックします。 3. グループ名を入力し、Salesforce ID プロバイダー名を選択します。 4. **\[Save (保存)\]**​ をクリックします。 ### [](#ユーザーグループが表示できる-api-を確認する)ユーザーグループが表示できる API を確認する ポータルメンバーのユーザーグループに表示される API と、ユーザーグループにのみ割り当てられた API を確認します。​**\[APIs visible to the user group (ユーザーグループに表示される API)\]**​ タブには、ポータルのメンバーが表示できるすべての API が表示されます。 1. **\[User groups (ユーザーグループ)\]**​ ページで、ユーザーグループを選択します。 2. **\[APIs visible to the user group (ユーザーグループに表示される API)\]**​ タブを選択します。 3. グループに割り当てられた API のみを表示するには、​**\[Show only APIs assigned to this group (このグループに割り当てられた API のみを表示)\]**​ を有効にします。 API の表示を確認または変更するには、​[「API バージョンを表示する」](https://docs.mulesoft.com/jp/api-experience-hub/managing-apis#make-api-versions-visible)​を参照してください。 ### [](#id-プロバイダーグループを削除する)ID プロバイダーグループを削除する 不要な外部 ID プロバイダーグループを削除する手順は、次のとおりです。 1. **\[User groups (ユーザーグループ)\]**​ ページで、ユーザーグループを選択します。 2. **\[External IdP groups (外部 IdP グループ)\]**​ タブを選択します。 3. リスト内でグループを見つけて、​**\[Remove group (グループを削除)\]**​ をクリックします。 ## [](#ログイン設定を管理する)ログイン設定を管理する **\[Login settings (ログイン設定)\]**​ ページを使用して、外部ユーザーのセルフ登録を無効または有効にし、ポータルのシングルサインオンをセットアップします。セルフ登録により、ゲストユーザーは自分自身を API Portal のメンバーとして登録できます。​**\[Pending requests (保留中の要求)\]**​ ページでは、ポータルへのアクセスを希望するゲストユーザーからの保留中の要求のリストを確認できます。 ### [](#セルフ登録を無効または有効にする)セルフ登録を無効または有効にする デフォルトでは、外部ユーザーがセルフ登録する機能は有効になっています。これにより、ゲストユーザーは登録を行い、メンバーになって、ポータルサイトにアクセスできます。管理者はセルフ登録を無効にできます。
セルフ登録は新規ユーザーのみを対象としています。 既存のユーザーはセルフ登録できません。ポータルにアクセスするには、ID プロバイダーを使用する必要があります。
外部ユーザーの登録を無効にするには、​**\[Login settings (ログイン設定)\]**​ ページで、​**\[Allow external user registration (外部ユーザー登録を許可)\]**​ オプションをオフにします。 外部登録を再び有効にするには、​**\[Allow external user registration (外部ユーザー登録を許可)\]**​ オプションをオンにします。 ### [](#シングルサインオン-sso-を設定する)シングルサインオン (SSO) を設定する **\[Single Sign-On (SSO) (シングルサインオン (SSO))\]**​ セクションでは、SSO を使用してポータルを設定する方法についての情報が提供されます。SSO の設定についての詳細な手順は、[ポータルでのシングルサインオンの有効化](https://docs.mulesoft.com/jp/api-experience-hub/enabling-sso-for-your-portal)を参照してください。 ### [](#salesforce-id-プロバイダーを管理する)Salesforce ID プロバイダーを管理する SSO を有効にするときに、新しい Salesforce ID プロバイダーを追加したり、以前に設定したプロバイダーを削除したり、必要に応じて有効または無効にしたりできます。ID プロバイダーが有効になっている場合、ユーザーはこの ID プロバイダーを使用してポータルにログインできます。 新しい ID プロバイダーを追加するか、既存の ID プロバイダーを削除する手順は、次のとおりです。 1. **\[User management (ユーザー管理)\]**​ で、​**\[Login settings (ログイン設定)\]**​ を選択します。 2. **\[Single sign-on (SSO) (シングルサインオン (SSO))\]**​ セクションから、​**\[Add Salesforce identity providers (Salesforce ID プロバイダーを追加)\]**​ セクションまでスクロールします。 3. **\[Select identity provider (ID プロバイダーを選択)\]**​ をクリックし、ドロップダウンメニューからオプションを選択します。 4. **\[+ Add identity provider (+ ID プロバイダーを追加)\]**​ をクリックします。 ID プロバイダーがリストに追加されます。 5. ID プロバイダーを削除する場合は、​**\[Delete (削除)\]**​ をクリックします。 ID プロバイダーを有効または無効する手順は、次のとおりです。 1. **\[Single sign-on (SSO) (シングルサインオン (SSO))\]**​ セクションから、​**\[Add Salesforce identity providers (Salesforce ID プロバイダーを追加)\]**​ セクションまでスクロールします。 2. ID プロバイダーの名前の横にあるスライダーを ​**\[Enabled (有効)\]**​ に移動します。 3. ID プロバイダーを無効にする場合は、スライダーを ​**\[Disable (無効)\]**​ に移動します。 ## [](#次のステップ)次のステップ **\[Preview and publish your portal (ポータルをプレビューしてパブリッシュ)\]**​ をクリックすることで​[エクスペリエンスビルダー](https://docs.mulesoft.com/jp/api-experience-hub/customizing-your-portal)​を使用してポータルをさらにカスタマイズしてブランド設定できます。 ## [](#関連情報)関連情報 - [ポータルにアクセスするための登録](https://docs.mulesoft.com/jp/api-experience-hub/registering-for-access-to-portal) # ユーザーロール、権限、およびプロファイル このトピックでは、Salesforce Experience Cloud および Anypoint Platform の API Experience Hub で使用されるユーザーロール、権限、およびプロファイルに関する情報を提供します。 - Anypoint Platform の場合、さまざまなアクセスレベルを持つユーザーは Anypoint アクセス管理を使用して管理されます。管理者と Exchange 閲覧者の権限を設定できます。詳細は、​[「Managing Permissions in Access Management (\[Access Management (アクセス管理)](https://docs.mulesoft.com/jp/access-management/managing-permissions) での権限の管理)」\]​を参照してください。 - Experience Cloud の場合、リンクプロセスを実行するユーザーにはシステム管理者プロファイルまたは ​AEH\_A​nypoint 権限セットが必要です。 ## [](#管理者)管理者 組織のシステム管理者ロールは、ポータルの作成、選定、管理、カスタマイズに必要なすべての権限を持ちます。このロールは、組織内の別のユーザーに「API Experience Hub Administrator (API Experience Hub 管理者)」権限を付与することもできます。この権限により、ユーザーは組織のシステム管理者と同じタスクをすべてポータルで実行できます。 API Experience Hub 管理者チームと API Experience Hub ポータル管理者チームは、接続およびリンクプロセス中にアクセス管理で作成されます。Salesforce 組織が Anypoint 組織に正常に接続されると、AEH 管理者チームが作成されます。AEH 管理者が割り当てられているユーザーは、自動的に AEH 管理者チームに追加されます。 ポータルのスタイリング変更が保存されると、AEH ポータル管理者チームが作成されます。API Experience Hub ポータル管理者チームはアクセス管理で表示されますが、この権限はこのリリースではサポートされません。 管理者が追加できるのは、「Exchange Viewer (Exchange 閲覧者)」権限を持つ API のみです。API がポータルに追加されると、すべての管理者には「Exchange Viewer (Exchange 閲覧者)」権限が自動的に割り当てられます。 API Experience Hub は、Salesforce Experience Cloud と統合されています。管理者は共有ユーザーアカウントを使用して Salesforce エクスペリエンスビルダーにアクセスできます。システム管理者の ID は共有されるため、API Experience Hub は共有アカウントで各管理者のアクションを区別できません。 システム管理者プロファイルには、Salesforce Platform で機能を実行するための特定の権限があります。このプロファイルを持つユーザーは、Salesforce Experience Cloud に接続し、Salesforce 組織を Anypoint 組織にリンクすることにより、API Portal を作成する最初のステップを実行します。このプロセスは、システム管理者プロファイルを持つユーザーのみが実行できます。​AEH\_A​nypoint 権限セットは、リンクプロセスを実行するユーザーに必要な最小限の権限のみを持たせるように作成することもできます。詳細は、[権限の割り当て](https://docs.mulesoft.com/jp/api-experience-hub/assigning-permissions)を参照してください。

ロール/権限/プロファイル

説明

アクション

Salesforce システム管理者

このプロファイルは、Salesforce リンクプロセスを実行するユーザーに割り当てる必要があります。

  • Salesforce リンクプロセスの実行

メイン組織の組織のシステム管理者

API Experience Hub はビジネスグループに依存しません。つまり、ポータルはメイン組織のみに属し、管理者はビジネスグループをまたいでポータルを作成できます。組織のシステム管理者はすべての API Experience Hub 権限を継承するため、プラットフォーム内で実行可能なすべての操作を実行できます。

  • Salesforce リンクプロセスの実行

  • ポータルの作成

  • ポータルでの API の追加および削除

  • API インスタンスの表示の割り当て

  • ユーザーの管理

  • エクスペリエンスビルダーを使用したポータルのカスタマイズ

API Experience Hub Administrator (API Experience Hub 管理者)

管理者は、API Portal を作成するために必要なすべての組織のシステム管理者権限を継承します。

  • Salesforce リンクプロセスの実行

  • ポータルの作成

  • ポータルでの API の追加および削除

  • API インスタンスの表示の割り当て

  • Salesforce および新規ポータルへの新規接続の作成

  • ユーザーの管理

  • エクスペリエンスビルダーを使用したポータルのカスタマイズ

API Experience Hub Portal Administrator (API Experience Hub ポータル管理者)

現在は、組織内の 1 つの API Portal のみを管理できます

  • ポータルでの特定の API の追加および削除

  • API インスタンスの表示の割り当て

### [](#exchange-権限)Exchange 権限 すべての管理者には、API をポータルにインポートするために「Exchange Viewer (Exchange 閲覧者)」権限が必要です。

権限

説明

アクション

Exchange Viewers (Exchange 閲覧者)

この権限は、組織のシステム管理者または Salesforce リンクプロセスを実行する API Experience Hub 管理者に割り当てます。この権限を持つユーザーは、新しいアセットの追加、アセットポータルコンテンツの編集、他のユーザーとのアセットの共有を行うことはできません。

  • Exchange での API の表示

  • Exchange からポータルへの API のインポート

## [](#詳細な権限と権限セット)詳細な権限と権限セット ユーザーに特定のタスクのみの実行を許可するには、次の権限または権限セットを使用します。権限と権限セットの設定についての詳細は、[権限の割り当て](https://docs.mulesoft.com/jp/api-experience-hub/assigning-permissions)を参照してください。

権限/権限セット

説明

アクション

API Experience Hub Users Approver (API Experience Hub ユーザー承認者)

ユーザーがユーザーを管理する特定のタスクを実行できるようにする詳細な権限。

  • ポータルへのユーザーの登録を承認または拒否する

  • ポータルへのユーザーのアクセスを有効または無効にする

AEH_A​nypoint 権限セット

Salesforce ユーザーがリンクプロセスを実行するために必要な最小限の権限を含む権限セット。

  • この権限セットを持つユーザーは、Salesforce リンクプロセスを実行できます。

## [](#コンシューマーユーザー)コンシューマーユーザー API Experience Hub には、次のコンシューマーユーザープロファイルが用意されています。 - ゲスト - メンバー これらは、アクセス管理のチーム機能を使用して管理できる特定の権限を持つユーザーのグループです。ゲストユーザーとメンバーユーザーの権限は、組織のポータルへのアクセス方法によって自動的に決定されます。ポータルにログインしないユーザーは匿名ユーザーとなり、このグループに割り当てられる権限と共にゲストユーザープロファイルが割り当てられます。ゲストユーザーは、ポータルの登録プロセスを完了することでメンバーになることができます。ユーザーの登録が承認されると、このユーザーはメンバーユーザープロファイルとその関連付けられた権限を継承します。アクセス管理のチームについての詳細は、​[「チームを使用したユーザーアクセスの管理」](https://docs.mulesoft.com/jp/access-management/teams)​を参照してください。

ユーザープロファイル

説明

アクション

ゲスト

このユーザーのプロファイルは匿名であり、API Portal にログインしていません。

  • 共有されている公開 API を表示する

  • セルフ登録してメンバーになれる

  • API へのアクセス権を要求できない

メンバー

これは、ポータルにログインできる登録済みユーザーです。

  • 共有されている公開 API とその他の API を表示する

  • セルフ登録を使用して登録済みであり、メンバーになっている

  • API へのアクセス権を要求する

## [](#関連情報)関連情報 - [API Experience Hub の使用開始](https://docs.mulesoft.com/jp/api-experience-hub/getting-started-with-api-experience-hub) - [権限の割り当て](https://docs.mulesoft.com/jp/api-experience-hub/assigning-permissions) - [Salesforce への接続](https://docs.mulesoft.com/jp/api-experience-hub/connecting-to-salesforce) # ユーザー分析の設定 Google アナリティクスを使用すると、コンシューマーが API とポータルをどのように使用しているかについて貴重なインサイトを得ることができ、改善の余地がある領域を特定し、データ主導の意思決定を行ってユーザーエクスペリエンスを最適化し、ビジネスの成功を促進できます。 Google アナリティクスは次のデータを追跡します。 - API 使用状況メトリクス: - API インスタンスのアクセス要求 - API 仕様のダウンロード - 参照回数が最多の API - API に対して行われたコールの合計数 - ユーザーエンゲージメントメトリクス: - 有効ユーザー - ログインイベント - API Console の使用状況: - API 要求 全体的な API 使用状況と API コンシュームでの ID パターンを測定します。API Console を介して API 要求が行われるたびに、行われた API 要求の総数を取得します。 - エンドポイント別の API 使用状況 一般的なエンドポイントを特定し、使用状況のトレンドを監視して、API 設計とリソース割り当てを最適化します。API Console を介して特定のエンドポイントに対して API 要求が行われるたびに、各 API エンドポイントに対して行われた要求の数を取得します。 ## [](#google-アナリティクスを設定する)Google アナリティクスを設定する ポータルからイベントを送信するように Google アナリティクスを設定する手順は、次のとおりです。 1. Google ドキュメントの [「Google アナリティクスのグローバルサイトタグを設定する」](https://support.google.com/analytics/answer/1008080?hl=en&visit_id=638531259961972871-3450454930&rd=1#zippy=%2Cin-this-article)​トピックの手順に従って、Google アナリティクスプロパティをセットアップします。 2. ビルダーに移動します。 3. **\[設定\]**​ > ​**\[セキュリティとプライバシー\]**​ をクリックします。 4. **\[コンテンツセキュリティポリシー (CSP)\]**​ セクションで、​**\[緩和された CSP: インラインスクリプトと許可されたホストへのアクセスを許可\]**​ を選択します。 5. **\[設定\]**​ で、​**\[詳細\]**​ をクリックします。 6. **\[詳細\]**​ ページで、Google アナリティクストラッキング ID を入力します。 7. **\[Google アナリティクスで Salesforce データにアクセスすることで、検索活動へのより深いインサイトが得られます。\]**​ を選択します。 8. **\[ヘッドマークアップを編集\]**​ をクリックします。 9. 次のコードを追加し、​`G-TRACK_ID`​ のすべてのインスタンスを Google アナリティクストラッキング ID に置き換えます。 10. **\[設定\]**​ で、​**\[セキュリティとプライバシー\]**​ をクリックします。 11. 次の URL が ​**\[スクリプト用の信頼済みサイト\]**​ に表示されていることを確認します。 - [https://www.google-analytics.com](https://www.google-analytics.com) - [https://www.googletagmanager.com](https://www.googletagmanager.com) 12. URL が欠落している場合は、​**\[信頼済みサイトを追加\]**​ をクリックして URL を追加します。 13. **\[設定\]**​ で、​**\[セキュリティ\]**​ > ​**\[信頼済み URL\]**​ をクリックします。 14. 同じ 2 つの URL が ​**\[信頼済み URL\]**​ セクションのリストにあることを確認します。 これで、API Experience Hub でポータルから Google アナリティクスの送信を開始できるようになりました。 # ライセンス ライセンスは、MuleSoft で調達され、プロビジョニングされます。API Experience Hub を使用するには、2 種類のライセンスが必要です。 - Salesforce このライセンスは、Salesforce エクスペリエンスビルダーを使用するために必要です。 - 外部 ID このライセンスは、ポータルにアクセスするためのメンバー要求の数に基づきます。現在のパッケージには 100 以上の API アクセス権の要求があり、2000 以上の外部 ID ライセンスが必要です。これは、ポータルコンシューマーが API Portal にアクセスするために必要です。 組織を設定するには、次の Salesforce エディションを使用できます。 - Unlimited Edition - Enterprise Edition - Salesforce の Performance Edition # 制限事項 このリリースには次の制限事項があります。 - API Experience Hub ではプラットフォームキャッシュを使用しません。 - API Experience Hub はメイン組織レベルでのみ機能します。 - Salesforce 組織を複数の Anypoint 組織に接続することはできません。 - Salesforce 組織ごとに複数のポータルはサポートされていません。 - API Portal に含めることができる API は最大 350 個です。 API Experience Hub の \[Access Management (アクセス管理)\] で作成された標準のチームの権限は変更しないでください。API Portal に追加された各アセットでは 2 つの権限が使用され、\[Access Management (アクセス管理)\] にはチームごとに 1000 個の権限の制限があります。 - API グループは使用できません。 - API Experience Hub は、モバイルデバイスでの使用は保証されていません。一部の機能はモバイルデバイスで動作しますが、API Console などの一部の機能は動作しません。 - IP 制限はサポートされていません。詳細は、​[「トラブルシューティング」](https://docs.mulesoft.com/jp/api-experience-hub/troubleshooting)​セクションを参照してください。 - 入力規則は、Salesforce リンクプロセス中に作成される標準オブジェクトには適用できません。詳細は、​[「トラブルシューティング」](https://docs.mulesoft.com/jp/api-experience-hub/troubleshooting)​セクションを参照して回避策を確認してください。 - 既存のユーザーはセルフ登録できません。ポータルにアクセスするには、ID プロバイダーを使用する必要があります。 - 保留中のユーザー登録要求の最大数は 500 です。詳細は、​[「ユーザーの管理」](https://docs.mulesoft.com/jp/api-experience-hub/managing-users)​を参照してください。 - コミュニティポータルのデフォルト名 API Experience Hub は変更できません。ポータルの名前を変更すると、設定でエラーが発生します。 - API Experience Hub では API の名前を変更できません。 - API Experience Hub Lightning カスタムコンポーネントは英語のみをサポートしています。詳細は、[API Experience Hub Lightning コンポーネント](https://docs.mulesoft.com/jp/api-experience-hub/api-experience-hub-lightning-components)を参照してください。 # 基本用語 \=| API アセット API Console API インスタンス クライアントアプリケーション Client ID (クライアント ID) クライアントプロバイダー Client secret (クライアントシークレット) コンシューマー コントラクト 環境 インスタンス 組織 組織のシステム管理者 組織のオーナー プロデューサー Salesforce エクスペリエンスビルダー Salesforce リンク SLA 層 チーム # 期限切れ間近の証明書の更新 接続アプリケーションにより、Anypoint Platform と Salesforce 組織間の双方向接続が可能になります。接続アプリケーションが適切に機能するには、デジタル証明書が必要です。これらの証明書には期限があり、期限切れになる可能性があります。 ## [](#証明書の生成方法)証明書の生成方法 接続プロセス中に、API Experience Hub は 1 年で期限切れになる自己署名証明書を生成します。 これらの自己署名証明書の 1 つで、Anypoint Platform 組織と Salesforce 組織がリンクされます。証明書と非公開キーは、Anypoint Security のシークレットマネージャーに保存されます。この証明書が期限切れになると、Salesforce インスタンスの管理者に通知は送信されません。ただし、Anypoint Platform と Salesforce 間の最初の接続は引き続き動作します。次回管理者が API Experience Hub にログインすると、接続エラーを示すエラーメッセージが表示され、管理者は再接続できます。管理者が API Experience Hub に再度ログインすると、有効期限が 1 年間の新しい証明書が自動的に生成されます。 API Experience Hub は Salesforce メタデータ API を使用して、接続プロセス中に Anypoint 証明書を生成します。接続アプリケーションはこの証明書を使用して、Anypoint からメタデータコンテンツにアクセスします。この証明書も 1 年間有効です。Salesforce インスタンスの管理者は、証明書が期限切れになる 30 日前にメールを受け取ります。指定ログイン情報は Anypoint 証明書を使用するため、証明書を削除することはできません。 ## [](#始める前に)始める前に 始める前に、API Experience Hub 管理者権限があることを確認してください。 ## [](#salesforce-id-データ証明書を更新する)Salesforce ID データ証明書を更新する 新しい Anypoint 証明書を生成する手順は、次のとおりです。 1. Salesforce に移動し、​**\[設定\]**​ > ​**\[セキュリティ\]**​ > ​**\[証明書と鍵の管理\]**​ をクリックします。 2. リスト内で ​**\[Anypoint\]**​ を見つけて ​**\[編集\]**​ をクリックうします。 3. 新しい名前 (例: **Anypoint to expire**​ (期限切れになる Anypoint)) を入力します。 ![証明書の名前を変更する例](/mulesoft/current/ja-jp/api-experience-hub/_images/aeh-rename-cert.png) 4. **\[保存\]**​ をクリックします。 5. API Experience Hub にログインして診断チェックをトリガーし、新しい証明書を作成します。 6. 名前を変更した証明書 (例: **Anypoint to expire**​ (期限切れになる Anypoint)) を削除します。 1. Salesforce に移動し、​**\[設定\]**​ > ​**\[セキュリティ\]**​ > ​**\[証明書と鍵の管理\]**​ をクリックします。 2. リスト内で名前を変更した証明書を見つけて、​**\[削除\]**​ をクリックします。 ## [](#関連情報)関連情報 - [Salesforce への接続](https://docs.mulesoft.com/jp/api-experience-hub/connecting-to-salesforce) - [指定ログイン情報](https://help.salesforce.com/s/articleView?id=sf.named_credentials_about.htm&type=5) # 権限の割り当て Anypoint Platform には、Anypoint Platform アクセス管理で設定してユーザーに異なるアクセスレベルを提供できる、定義済みの権限が付属しています。管理者と Exchange 閲覧者の権限を設定します。 Salesforce プラットフォームは、Salesforce で特定のタスクを実行する権限を含むシステム管理者プロファイルを使用します。API Experience Hub の場合、Salesforce リンクを実行するユーザーにこのプロファイルまたは ​AEH\_A​nypoint 権限セットが必要です。 ## [](#始める前に)始める前に - 組織のシステム管理者または既存の API Experience Hub 管理者である必要があります。 - Anypoint 組織と Salesforce 組織のユーザーの権限戦略を検討します。詳細は、[ユーザーロール、権限、およびプロファイル](https://docs.mulesoft.com/jp/api-experience-hub/user-roles-permissions-and-profiles)を参照してください。 - AEH\_A​nypoint 権限セットが割り当てられている Salesforce ユーザーは、Salesforce ライセンスと標準ユーザープロファイルが必要です。 ## [](#api-experience-hub-administrator-api-experience-hub-管理者権限とexchange-viewer-exchange-閲覧者権限を付与する)「API Experience Hub Administrator (API Experience Hub 管理者)」権限と「Exchange Viewer (Exchange 閲覧者)」権限を付与する 組織のシステム管理者と API Experience Hub 管理者は、ポータルを作成するすべての機能を実行できます。ユーザーに「API Experience Hub Administrator (API Experience Hub 管理者)」権限を付与できるのは、組織のシステム管理者または既存の API Experience Hub 管理者のみです。この権限を付与するのは、組織の別のユーザーに Salesforce リンクプロセスの実行、ポータルの作成と選定、ポータルの管理、ユーザーの管理を行わせる場合です。 管理者が API をポータルに追加するには、それらの API に対する「Exchange Viewer (Exchange 閲覧者)」権限を持っている必要があります。 API がポータルに追加されると、すべての管理者にはポータルに追加された API に対する「Exchange Viewer (Exchange 閲覧者)」権限が自動的に割り当てられます。 管理者に権限を付与する手順は、次のとおりです。 1. **\[Access Management (アクセス管理)\]**​ に移動します。 2. **\[Users (ユーザー)\]**​ をクリックし、「API Experience Hub Administrator (API Experience Hub 管理者)」権限を追加するユーザーのユーザー名をクリックします。 3. **\[Permissions (権限)\]**​ を選択し、​**\[Add Permissions (権限を追加)\]**​ をクリックします。 4. **\[Select permissions to add for this user (このユーザーについて追加する権限を選択)\]**​ 検索ボックスで、​**「API Experience Hub Amin」**​ (API Experience Hub 管理者) と入力してチェックボックスをオンにします。 5. 検索ボックスに​**「Exchange viewer」**​ (Exchange 閲覧者) と入力して、​**\[Next (次へ)\]**​ をクリックします。 6. **\[Mulesoft\]**​ チェックボックスをオンにして、​**\[Next (次へ)\]**​ をクリックします。 7. **\[Add Permissions (権限を追加)\]**​ をクリックします。 ## [](#salesforce-ユーザーがリンクプロセスを実行するための最小権限を持つ-aeh_anypoint-権限セットを作成する)Salesforce ユーザーがリンクプロセスを実行するための最小権限を持つ ​AEH\_A​nypoint 権限セットを作成する Salesforce Experience Cloud に接続し、Salesforce 組織を Anypoint Platform 組織にリンクするには、システム管理者プロファイルを持つ Salesforce ユーザーが必要です。システム管理者プロファイルには、必要以上の権限が付与されている可能性があります。既存の Salesforce 組織を使用し、機密データを持つ可能性があるユーザーの場合、最小権限の原則に従ってそのデータのセキュリティを確保します。​AEH\_A​nypoint 権限セットを使用して、リンクプロセスを実行するユーザーの権限のみを設定します。システム管理者プロファイルを持つ Salesforce ユーザーが、必要なすべての権限を含む ​AEH\_A​nypoint 権限セットを作成し、その権限セットを Salesforce ユーザーに割り当てます。Salesforce で権限セットを手動で作成するか、​`AEH_Anypoint.permissionset-meta.xml`​ メタデータファイルを使用して CI/CD パイプライン経由でデプロイします。 Salesforce への接続前後に設定された権限を使用して、システム管理者の権限をダウングレードできます。Salesforce ユーザーが接続を作成したユーザーと同じである場合は、ポータルを切断して接続を再作成することなく、そのユーザーを ​AEH\_A​nypoint 権限セットに割り当てることができます。接続を作成しなかった Salesforce ユーザーに権限セットを割り当てるには、ポータルを切断し、接続を再作成する必要があります。たとえば、Salesforce に接続していた元の Salesforce ユーザーが退職したとします。 次の手順を実行して、権限セットを手動で作成し、必要な権限を追加して、権限セットにユーザーを割り当てます。 1. AEH\_A​nypoint 権限セットを作成します。 1. システム管理者として Salesforce にログインします。 2. **\[設定\]**​ の ​**\[クイック検索\]**​ ボックスに​`「権限セット」`​と入力し、​**\[権限セット\]**​ をクリックします。 3. **\[新規\]**​ をクリックします。 4. **\[表示ラベル\]**​ 項目と ​**\[API 参照名\]**​ 項目の両方に、表示されているとおりに​`「AEH_Anypoint」`​と入力します。 5. **\[保存\]**​ をクリックします。 2. 必要な権限を権限セットに追加します。 1. **\[システム\]**​ セクションで ​**\[システム権限\]**​ をクリックします。 2. **\[編集\]**​ をクリックします。 3. **\[システム\]**​ セクションで、次の​_必須_​の権限を有効にします。 必須権限 - Apex REST サービス - API の有効化 - トピックを割り当てる - Apex 開発 - 環境ハブへの組織の追加 - ダッシュボードの作成とカスタマイズ - リストビューを作成およびカスタマイズ - レポートの作成とカスタマイズ - エクスペリエンスの作成および設定 - ダッシュボードフォルダーを作成 - レポートフォルダーを作成 - トピックを作成 - アプリケーションのカスタマイズ - トピックを削除 - AppExchange パッケージのダウンロード - 行動の編集 - HTML テンプレートの編集 - 私のダッシュボードを編集 - 私のレポートを編集 - ToDo の編集 - トピックを編集 - 認証プロバイダーの管理 - 接続アプリケーションを管理する - カスタム権限を管理 - 公開フォルダーのダッシュボードを管理 - レターヘッドの管理 - ユーザーインターフェースで多要素認証を管理 - Classic の公開メールテンプレートを管理 - 公開ドキュメントの管理 - 公開リストビューを管理 - 公開フォルダーのレポートを管理 - セッション権限セットのアクティベーションを管理 - すべてのデータの編集 - メタデータ API 関数を使用したメタデータの変更 - レポート実行 - 所有権の移行 - すべてのデータの参照 - 公開フォルダーのダッシュボードを参照 - イベントログファイルを参照 - 公開フォルダーのレポートを参照 - ロールおよびロール階層を表示 - 設定・定義を参照する 4. **\[ユーザー\]**​ セクションで、次の​_必須_​の権限を有効にします。 必須権限 - 権限セットの割り当て - 内部ユーザーの管理 - IP アドレスを管理 - ログインアクセスポリシーを管理 - パスワードポリシーを管理 - プロファイルおよび権限セットを管理 - ロールを管理 - Sandbox を管理 - 共有を管理 - ユーザーの管理 - ユーザーパスワードのリセットおよびユーザーのロック解除 - すべてのユーザーの参照 5. 権限セットに追加する他の権限を有効にします。 6. **\[保存\]**​ をクリックします。 3. 権限セットを Salesforce ユーザーに割り当てます。 このユーザーは、Salesforce ライセンスと標準ユーザープロファイルが必要です。 1. **\[設定\]**​ の ​**\[クイック検索\]**​ ボックスに​`「ユーザー」`​と入力し​**\*​、​**\[ユーザー\]\*​ をクリックします。 2. **\[氏名\]**​ 列で、ユーザーの名前を選択します。 3. **\[権限セットの割り当て\]**​ セクションで、​**\[割り当ての編集\]**​ をクリックします。 4. **\[利用可能な権限セット\]**​ リストから ​**\[​AEH\_A​nypoint\]**​ を選択し、そのセットを ​**\[有効化された権限セット\]**​ リストに移動します。 5. **\[保存\]**​ をクリックします。 CI/CD を介して権限セットをデプロイするには、次の ​`AEH_Anypoint.permissionset-meta.xml`​ メタデータファイルを使用して、権限セットを Salesforce ユーザーに割り当てます。 1. メタデータファイルをコピーし、​`AEH_Anypoint.permissionset-meta.xml`​ という名前のファイルを作成します。 ```xml false true ApexRestServices true ApiEnabled true AssignPermissionSets true AssignTopics true AuthorApex true ConnectOrgToEnvironmentHub true ConvertLeads true CreateCustomizeDashboards true CreateCustomizeFilters true CreateCustomizeReports true CreateDashboardFolders true CreateReportFolders true CreateTopics true CustomizeApplication true DelegatedTwoFactor true DeleteTopics true EditBrandTemplates true EditEvent true EditHtmlTemplates true EditMyDashboards true EditMyReports true EditPublicDocuments true EditPublicFilters true EditPublicTemplates true EditTask true EditTopics true ImportLeads true InstallPackaging true ManageAuthProviders true ManageCategories true ManageCustomPermissions true ManageDashbdsInPubFolders true ManageInternalUsers true ManageIpAddresses true ManageLoginAccessPolicies true ManageNetworks true ManagePasswordPolicies true ManageProfilesPermissionsets true ManageQuotas true ManageRemoteAccess true ManageReportsInPubFolders true ManageRoles true ManageSandboxes true ManageSessionPermissionSets true ManageSharing true ManageTerritories true ManageTranslation true ManageUsers true ModifyAllData true ModifyDataClassification true ModifyMetadata true OverrideForecasts true ResetPasswords true RunReports true SolutionImport true TransferAnyEntity true TransferAnyLead true UseTeamReassignWizards true ViewAllData true ViewAllForecasts true ViewAllUsers true ViewEventLogFiles true ViewPublicDashboards true ViewPublicReports true ViewRoles true ViewSetup ``` 2. 次のコマンドを実行し、​`path/to/permissionset/`​ 変数と ​`orgAlias`​ 変数を自分のパスと組織の別名に置き換えます。 ```code sf project deploy start --source-dir path/to/permissionset/ -o orgAlias ``` 3. 権限セットが作成されたことを確認します。 1. システム管理者として Salesforce にログインします。 2. **\[設定\]**​ の ​**\[クイック検索\]**​ ボックスに​`「権限セット」`​と入力し、​**\[権限セット\]**​ をクリックします。 3. リスト内で ​**AEH\_A​nypoint**​ を見つけます。 ## [](#api-experience-hub-users-approver-api-experience-hub-ユーザー承認者権限を割り当てる)「API Experience Hub Users Approver (API Experience Hub ユーザー承認者)」権限を割り当てる 「API Experience Hub Users Approver (API Experience Hub ユーザー承認者)」権限を割り当てて、ユーザーが保留中の登録要求を承認または拒否し、メンバーユーザーのみを有効または無効にできるようにします。 この権限により、​**\[Manage your API Portal (API Portal を管理)\]**​ の次の ​**\[User management (ユーザー管理)\]**​ ページへのアクセス権が付与されます。 - Portal members (ポータルメンバー) ポータルへのユーザーのアクセスを有効または無効にします。 - Pending registration requests (保留中の登録要求) ユーザーの登録要求を承認または拒否します。 - Settings (設定) Salesforce アカウントおよびポータルに関する情報を表示します。 この権限をユーザーに割り当てる手順は、次のとおりです。 1. **\[Access Management (アクセス管理)\]**​ に移動します。 2. **\[Users (ユーザー)\]**​ をクリックしてユーザー名を選択します。 3. **\[Permissions (権限)\]**​ を選択し、​**\[Add Permissions (権限を追加)\]**​ をクリックします。 4. **\[Select permissions to add for this user (このユーザーについて追加する権限を選択)\]**​ 検索ボックスで、​**「API Experience Hub Users Approver」**​ (API Experience Hub ユーザー承認者) と入力してチェックボックスをオンにします。 5. **\[Next (次へ)\]**​ をクリックします。 6. **\[Mulesoft\]**​ チェックボックスをオンにして、​**\[Next (次へ)\]**​ をクリックします。 7. **\[Add Permissions (権限を追加)\]**​ をクリックします。 ## [](#関連情報)関連情報 - [ユーザーロール、権限、およびプロファイル](https://docs.mulesoft.com/jp/api-experience-hub/user-roles-permissions-and-profiles) - [Salesforce への接続](https://docs.mulesoft.com/jp/api-experience-hub/connecting-to-salesforce)