API Commerce Salesforce Unmanaged Package Post Installation Instructions

Following installation of the Revenium Anypoint Community Manager (ACM) package, additional configuration steps are required to activate its functionality within your organization.

After installing the Revenium API Commerce Salesforce Package, there are a few steps needed before you can use it in your organization.

Important ACM Pre-Requisites:

ACM setup requires a scope to be set in the named credential for Anypoint in Salesforce to determine which APIs from Anypoint can be visible in the Revenium package.

  • Search in Salesforce for "Named Credentials" and the "Anypoint" named credential to verify this is set up correctly (Figure 1).

You also need to make sure your users in ACM are assigned to a Team in Anypoint Platform with the following permissions:

CategoryPermissions

Exchange

Exchange Viewer

API Manager

Manage Contracts View Contracts

Table 1. Anypoint Team's configuration.

If you would not like to receive the default Anypoint email notifications follow this guide.

1. Create Revenium URL and Revenium API Keys Custom Object Tabs

  1. Go to Setup > Tabs, and under Custom Object Tabs, click on New (Figure 2).

  2. In the Custom Object Tab form (Figure 3) select Revenium URL in the object field.

  3. Select a Tab style, add a meaningful description and click on Next.

  4. Restrict the access to this tab to meet your Organization’s needs and click on Save.

  5. In the Custom Object Tab form (Figure 3) select Revenium API Key in the object field.

  6. Select a Tab style, add a meaningful description and click on Next.

  7. Restrict the access to this tab to meet your Organization’s needs and click on Save.

2. Create Revenium URLs

  1. Navigate to the Revenium URL Custom Tab you created in Step 2 and click on New (Figure 4).

  2. Create a Revenium URL, as described in Table 1.

Revenium URL NameURLActiveURL Type

Revenium API URL

URL provided by Revenium staff. Default is: https://api.revenium.io/profitstream/v1/api

Yes

API

Table 2. Revenium URL configuration.

3. Create Revenium API Keys

  1. Navigate to the Revenium API Keys Custom Tab you created in Step 2 and click on New (Figure 5).

  2. Create a Revenium API Key, as described in Table 2.

Revenium API Key Name *KeyKey Owner

Revenium API Key

User who will use the API Key

Table 2. Revenium API Key configuration.

4. Add Trusted URLs

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

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

Trusted Site NameTrusted Site URLActiveContextCSP 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 3. 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.

5. Configure Remote Site Settings

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

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

Remote Site NameTrusted Site URLDisable Protocol SecurityActive

Revenium_API_URL

Yes

Yes

Table 4. Revenium API Key configuration.

6. Assigning Revenium User Permission Set.

When using the Revenium Anypoint API Experience Hub Package with a Salesforce Profile different from System Administrator or API Experience Hub Member User, you need to assign the Permission Set Revenium User to the users under that profile in order to make it work. To do this, go to Setup > Permission Sets > Revenium User > Manage Assignments (Figure 8). After that, assign the corresponding users to it and click Next (Figure 9). Finally, select an expiration date if appropriate and click Assign (Figure 10).

7. Configuring the Guest User.

Only go through this instructions if your site allows public access (guest users).

When using the Revenium API Commerce Salesforce Package with a Guest User, you need to add the permissions specified in Table 5 to make it work.

NameTypePermission

Current HC Org

User field

Read/edit

HcApiKeyHelper

Apex Class

Access

UrlHelper

Apex Class

Access

ProductsRepository

Apex Class

Access

UserHelper

Apex Class

Access

IntegrationHelper

Apex Class

Access

OrganizationsManager

Apex Class

Access

AnypointRepository

Apex Class

Access

ApplicationsRepository

Apex Class

Access

AssetsRepository

Apex Class

Access

DateParserUtil

Apex Class

Access

DateHelper

Apex Class

Access

ProductKeysRepository

Apex Class

Access

RaygunController

Apex Class

Access

Revenium API Keys

Custom Object

Read

Revenium API Urls

Custom Object

Read

Anypoint

Named Credential

Access

Table 5. Required Guest User permissions.

You can do this by taking the following steps:

  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 11).

In the Field-Level Security section you can set the Read/Edit access for the Current RM Org field from the User object (Figure 12). 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 13).

Finally, allow the Guest Users to access Private Resources.

8. Configuring Sharing Rules.

You will also need to create a Sharing Rule to grant access to the Custom Objects to a certain group of users. To do this, you should navigate to Setup > Sharing Settings > Revenium API Key Sharing Rules (and Revenium URLs Sharing Rules). For example, if you want to share the records owned by a certain role with all the users in the portal with a particular role assigned, you would need to define it in this way (Figure 14). You can see the following link to know more about Sharing Rules.

If you allowed Guest Users in your organization (and have followed the instructions in #7), you need to add Sharing Rules for the Experience Site Guest User as outlined here.

When using the Revenium ACM package with the Anypoint Community Manager, a Sharing Rule for the Community API Object will also be needed. You can follow the above steps to achieve this.

9. Remove the API's standard request access button.

It is necessary to remove this button so that dev portal users only receive access to your monetized APIs through the Revenium drop-in storefront. This way you can require payment before access is granted.

In order to remove the API's standard request access button from ACM, shown in Figure 16, please drag and drop the Remove Asset Access component above the Template footer on the Application Details page of the site (Figure 17).

10. Add products and assets to your portal.

Not adding your products and assets to your portal will result in inconsistent behaviour in your ACM account and the inability to view contracts in your portal.

Finally, you will need to add the products/assets you have created in Revenium to your ACM portal. To do this, first create your product or asset in Revenium. Then, you will need to synchronize them to your Anypoint's account. After this, go to API Community Manager application in Salesforce and then go to the API Curator. Select the site you are working on from the site's dropdown menu shown in Figure 18.

Go to the Assets in Anypoint Exchange tab. If you've followed the previous steps you should be able to add the product/asset to your portal site by searching for its name in the search box, selecting it and then clicking the Add to your site button, as depicted in Figure 19. Click Add in the following screen prompt.

To check that it has been properly added to your site, go to Assets in your Site tab and search for your product/asset. If there were no errors in the process your product/asset should be listed there (Figure 20).

Your site is now all set for use with Revenium's ACM integration.

Last updated

© Revenium - www.revenium.io