Following installation of the Revenium Anypoint Community Manager (ACM) package, additional configuration steps are required to activate its functionality within your organization.
Last updated
© Revenium - www.revenium.io
Make sure that Lightning Web Service is enabled in your organization.
After installing the Revenium API Commerce Salesforce Package, there are a few steps needed before you can use it in your organization.
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 subscribers in ACM are assigned to a Team in Anypoint Platform with the following permissions:
| Category | Permissions |
|---|---|
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.
Go to Setup > Tabs, and under Custom Object Tabs, click on New (Figure 2).
In the Custom Object Tab form (Figure 3) select Revenium URL in the object field.
Select a Tab style, add a meaningful description and click on Next.
Restrict the access to this tab to meet your Organization’s needs and click on Save.
In the Custom Object Tab form (Figure 3) select Revenium API Key in the object field.
Select a Tab style, add a meaningful description and click on Next.
Restrict the access to this tab to meet your Organization’s needs and click on Save.
Navigate to the Revenium URL Custom Tab you created in Step 2 and click on New (Figure 4).
Create a Revenium URL, as described in Table 1.
| Revenium URL Name | URL | Active | URL 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.
Navigate to the Revenium API Keys Custom Tab you created in Step 2 and click on New (Figure 5).
Create a Revenium API Key, as described in Table 2.
| Revenium API Key Name * | Key | Key Owner |
|---|---|---|
Revenium API Key | Subscriber who will use the API Key |
Table 2. Revenium API Key configuration.
Go to Setup > Security > Trusted URLs and click on New Trusted Site (Figure 6).
Create the required Trusted Sites as described in Table 3.
| 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 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.
Go to Setup > Security > Remote Site Settings and click on New Remote Site (Figure 7).
Create the required Remote Sites as described in Table 4.
| Remote Site Name | Trusted Site URL | Disable Protocol Security | Active |
|---|---|---|---|
Revenium_API_URL | Yes | Yes |
Table 4. Revenium API Key configuration.
When using the Revenium Anypoint API Experience Hub Package with a Salesforce Profile different from System Administrator or API Experience Hub Member Subscriber, you need to assign the Permission Set Revenium Subscriber to the subscribers under that profile in order to make it work. To do this, go to Setup > Permission Sets > Revenium Subscriber > Manage Assignments (Figure 8). After that, assign the corresponding Subscribers to it and click Next (Figure 9). Finally, select an expiration date if appropriate and click Assign (Figure 10).
Only go through this instructions if your site allows public access (guest subscribers).
When using the Revenium API Commerce Salesforce Package with a Guest Subscriber, you need to add the permissions specified in Table 5 to make it work.
| Name | Type | Permission |
|---|---|---|
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 subscribers permissions.
You can do this by taking the following steps:
In Salesforce Setup, enter sites in the Quick Find box and select All Sites.
Next to the site that you want to access, click Builder.
In Experience Builder, click the Settings icon and select General.
Under Guest Subscriber Profile, click the guest subscriber 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 Subscriber 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.
You will also need to create a Sharing Rule to grant access to the Custom Objects to a certain group of Subscribers. 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 Subscribers 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 Subscribers in your organization (and have followed the instructions in #7), you need to add Sharing Rules for the Experience Site Guest Subscriber 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.
It is necessary to remove this button so that dev portal Subscribers 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 Source Access component above the Template footer on the Application Details page of the site (Figure 17).
Not adding your products and sources to your portal will result in inconsistent behavior in your ACM account and the inability to view contracts in your portal.
Finally, you will need to add the products/sources you have created in Revenium to your ACM portal. To do this, first create your product or source 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 Sources in Anypoint Exchange tab. If you've followed the previous steps you should be able to add the product/source 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 Sources in your Site tab and search for your product/source. If there were no errors in the process your product/source should be listed there (Figure 20).
Your site is now all set for use with Revenium's ACM integration.
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 API Detail detail page (Figure 18).
By placing this component on an source 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.
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.
