Anypoint API Experience Hub Unmanaged Package Post Installation Instructions

After installing the Revenium Anypoint API Experience Hub (AEH) Package, some configuration is needed before you can use it in your organization.

Anypoint Experience Hub can be installed in two ways: through a self-service approach or with assisted guidance from our team. First, make sure you meet the requirements to install it. For a hands-on experience, follow these detailed instructions. If you prefer assistance, our team can walk you through the process. To enable this, you'll need to grant permissions for us to access Anypoint Experience Hub in your Anypoint account. While we recommend self-service to familiarize yourself with the platform, our team is happy to provide support!

1. Updating the Revenium API Credential External Credential

To ensure seamless integration with Revenium, you must update the Revenium API Credential External Credential in Salesforce with the one you obtained from Revenium.

Follow these steps to locate and modify the External Credential:

  1. Navigate to Setup:

    • In Salesforce, click the gear icon (Setup) in the top-right corner.

    • Select Setup from the dropdown menu.

  2. Access Named Credentials:

    • In the Quick Find box on the left sidebar, type "Named Credentials".

    • Select Named Credentials under Integrations.

  3. Locate the External Credential:

    • On the Named Credentials page, find and click on the Revenium Named Credential.

    • On the Revenium Named Credential detail page, locate the External Credentials section and click on the Revenium API Credential.

  4. Edit the API key in the Custom Header:

    • Within the Revenium API Credential details, locate the section related to "Custom Header Parameters".

    • Find the custom header parameter with the name X-API-KEY.

    • Click Edit next to this parameter.

    • Click Save.

2. Add Trusted URLs

  1. Go to Setup > Security > Trusted URLs and click on New Trusted Site (Figure 1).

  2. Create the required Trusted Sites as described in Table 1.

Figure 1. New Trusted Site button.
Trusted Site Name
Trusted Site URL
Active
Context
CSP Directives

Revenium_API_URL

Yes

All

Allow site for connect-src, Allow site for frame-src

Stripe_API

Yes

All

Allow site for connect-src, Allow site for frame-src

Google_Pay

Yes

All

Allow site for connect-src, Allow site for frame-src

Raygun_API

Yes

All

Allow site for connect-src

Revenium_CDN

Yes

All

Allow site for img-src

Salesforce_Maps

Yes

All

Allow site for connect-src, Allow site for frame-src

Table 1. Trusted URLs configuration.

If you use external images in your product description fields that support markdown syntax, you need to add the images host to the Trusted URLs configuration with the "Allow site for img-src" option enabled.

3. Configure Remote Site Settings

  1. Go to Setup > Security > Remote Site Settings and click on New Remote Site (Figure 2).

  2. Create the required Remote Sites as described in Table 2.

Figure 2. New Remote Site button.
Remote Site Name
Trusted Site URL
Disable Protocol Security
Active

Table 2. Revenium API Key configuration.

4. Assigning Revenium User Permission Set.

When using the Revenium Salesforce Package with a Salesforce Profile different from System Administrator, you need to assign the Permission Set Revenium User to the subscribers under that profile in order to make it work. To do this, go to Setup > Permission Sets > Revenium User > Manage Assignments (Figure 3). After that, assign the corresponding subscribers to it and click Next (Figure 4). Finally, select an expiration date if appropriate and click Assign (Figure 5).

Figure 3. Permission Set's Manage Assignments button.
Figure 4. Permission Set assignment.
Figure 5. Setting an expiration date for the Permission Set.

5. Configuring the Guest User.

  1. In Salesforce Setup, enter sites in the Quick Find box and select All Sites.

  2. Next to the site that you want to access, click Builder.

  3. In Experience Builder, click the Settings icon and select General.

  4. Under Guest User Profile, click the guest user profile link (Figure 6).

Figure 6. Guest User profile configuration access.

In the Field-Level Security section you can set the Read/Edit access for the Current RM Org field from the Subscriber object (Figure 7). Moreover, in this profile menu you will see the options to enable access to Apex Classes, Custom Objects and Named Credentials listed in Table 5 (Figure 8).

Figure 7. Current RM Org Field Level Security settings.
Figure 8. Edit Profile access to Apex Classes, Custom Objects and Named Credentials.

Finally, allow the Guest Users to access Private Resources:

  1. In the site's Builder, navigate to Settings, then select General.

  2. Under Guest User Profile, click the profile name.

  3. Click System Permissions.

  4. Click Edit.

  5. Select the View Private Static Resources permission and click Save.

6. Add products/APIs to your portal.

In order to access products or APIs from Revenium's components in your site you need to add them from AEH's API manager. To do that, click on API Experience Hub in your Anypoint account and then add the products/APIs you want from Exchange, as shown in Figures 9 and 10.

Figure 9. Adding API to portal from Exchange.
Figure 10. The API has been added to the portal.

7. Set the Revenium "View Available Products" button

To ensure a smooth workflow for Subscribers requesting access to your API bundles, it's essential to include the "View Available Products" button directly on your Community Source detail page (Figure 11).

By placing this component on an sources details page, a button will appear that will do two things, 1) return the Subscriber to the catalog page including the “Drop-In Storefront” component, 2) filter the list of displayed products in the displayed storefront to show only products that contain the source on the original page that the user was browsing.

This allows Subscribers who are interested in using a particular API to understand which products they can purchase that include that API. By having the button readily available, Subscribers can efficiently access the storefront and request access to the desired API bundles within a single, streamlined experience.

Figure 11. API Access Requester is put in the Community Asset detail page.

You also need to provide the API name of the page your storefront is located by following the instructions outlined in the API Access Requester documentation. By default, the API Access Requester button redirects you to the Home page of your Experience Cloud site.

Resources

Anypoint API Experience Hub documentation

Anypoint API Experience Hub prerequisites

Last updated

Was this helpful?