LogoLogo
  • User Guide
    • Getting Started
      • Building a Usage-Based Product in Revenium
      • Setting Up & Using API Analytics & Observability
      • Setting Up & Using Product Analytics
      • Sending Data to Revenium's Metering API
      • Key Concepts & Relationships
    • Connect Your Data
      • cURL Commands for Testing
      • Container-Native Metering
      • Kong
        • Kubernetes Installation
      • Salesforce
        • Revenium Unmanaged Package
          • Anypoint API Experience Hub (AEH)
            • Anypoint API Experience Hub Unmanaged Package Post Installation Instructions
          • Anypoint Community Manager (ACM)
            • Anypoint Community Manager Package Post Installation Instructions
        • Revenium Lightning Web Components
          • Add Components to Experience Cloud site
          • Drop-In Storefront
          • Product Card
          • Product Card (Anypoint)
          • Product Checkout
          • Product Details Button
          • Usage History
          • API Access Requester
      • MuleSoft
        • Metering Policy Configuration
        • Offline Metering Policy Configuration
        • Anypoint API & API Group Synchronization
        • Revenium Connector
        • Disable Default Anypoint Community Manager (ACM) Email Notifications
      • Gravitee
      • Istio
      • Envoy
      • AWS API Gateway
      • Python & Django
      • Golang
      • Spring Boot
      • .Net
      • NodeJs
      • Java/JVM
      • Snowflake
      • Azure API Management
      • IBM
      • Custom Integrations Using Metering Beacons
        • JWT Enrichment
      • Offline Metering via Log Parsing
    • Sources
      • Metering Elements
      • Alerts
        • Alert History
    • API Keys
    • Products & Pricing
      • Product Lines
      • Pricing Rules
        • Revenium Scripting Language
          • RSL Reference
        • Execution Logs
      • SLA Definitions
      • SLA Violation Review
    • Customers
      • Customers
      • Subscribers
      • Subscriptions
      • Subscribers Credentials
      • Subscribers Notifications
    • Billing and Invoicing
      • Manage Refunds
    • Analytics
      • Revenue Analytics
      • Product Analytics
        • Custom Reports (Products)
      • Subscriber Analytics
        • New Subscribers
        • (Daily/Weekly/Monthly) Active Subscribers
        • Most Engaged Subscribers & Customers
        • Historical Usage
      • API Analytics
        • Performance & Availability
        • Compare Periods
        • Traffic by Geography
        • Advanced Search
        • Custom Reports
    • Profile
      • Profile
      • Revenium API Documentation
    • Settings
      • Revenium Users & Organizations
        • Access Permissions by User Type
      • Revenium Subscription
      • Revenium Organizations
      • Notification Templates
      • Transactions Logs
        • Analytics Transaction Log
        • Product Transaction Log
        • Subscription Audit Log
        • No Code Transaction Testing
      • Integrations
        • Data Sync
        • Export Configurations
        • Notification Providers
        • Payment Configurations
          • Customer VAT ID Support
        • ERP Configurations
        • External Integration Logs
        • Identity Providers
      • System Logs
      • Default Configuration Limits
Powered by GitBook

© Revenium - www.revenium.io

On this page
  • Important ACM Pre-Requisites:
  • 1. Create Revenium URL and Revenium API Keys Custom Object Tabs
  • 2. Create Revenium URLs
  • 3. Create Revenium API Keys
  • 4. Add Trusted URLs
  • 5. Configure Remote Site Settings
  • 6. Assigning Revenium Subscriber Permission Set.
  • 7. Configuring the Guest Subscriber.
  • 8. Configuring Sharing Rules.
  • 9. Remove the API's standard request access button.
  • 10. Add products and Sources to your portal.
  • 11. Set the Revenium API Access Requester button.
  1. User Guide
  2. Connect Your Data
  3. Salesforce
  4. Revenium Unmanaged Package
  5. Anypoint Community Manager (ACM)

Anypoint Community Manager 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.

Last updated 3 months ago

Make sure that .

After installing the Revenium Unmanaged Package within the context of Anypoint Community Manager (ACM), 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).

Category
Permissions

Exchange

Exchange Viewer

API Manager

Manage Contracts View Contracts

Table 1. Anypoint Team's configuration.

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 Name
URL
Active
URL Type

Revenium API URL

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 *
Key
Key Owner

Revenium API Key

Subscriber 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 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.

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 Name
Trusted Site URL
Disable Protocol Security
Active

Revenium_API_URL

Yes

Yes

Table 4. Revenium API Key configuration.

6. Assigning Revenium Subscriber Permission Set.

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

7. Configuring the Guest Subscriber.

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:

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

8. Configuring Sharing Rules.

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

10. Add products and Sources to your portal.

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.

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.

11. Set the Revenium API Access Requester 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 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 make sure your subscribers in ACM are assigned to a in Anypoint Platform with the following permissions:

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

Figure 2. New Custom Object Tab button.
Figure 4. New Revenium URL button.

URL provided by Revenium staff. Default is:

Figure 5. New Revenium API Key button.

Figure 6.New Trusted Site button.

Figure 7. New Remote Site button.

Figure 12. Current RM Org Field Level Security settings.

Finally, .

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 .

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 .

Figure 16. Standard request access button.
Figure 17. Remove Asset Access component.

Finally, you will need to add the products/sources you have created in Revenium to your ACM portal. To do this, first or in Revenium. Then, you will need to . 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.

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

Team
follow this guide
allow the Guest Users to access Private Resources
Sharing Rules
here
create your product
source
synchronize them to your Anypoint's account
by following the instructions outlined in the API Access Requester documentation
https://api.revenium.io/profitstream/v1/api
API Key generated in your Revenium's account
https://api.revenium.io/
https://js.stripe.com
https://pay.google.com
https://cdn.raygun.io
https://cdn.prod.hcapp.io
https://maps.a.forceusercontent.com
https://api.revenium.io/profitstream/v1/api
Lightning Web Service is enabled in your organization
Figure 1. Named Credential Requirement:
Figure 3. New Custom Object Tab form.
Figure 8. Permission Set's Manage Assignments button.
Figure 9. Permission Set assignment.
Figure 10. Setting an expiration date for the Permission Set.
Figure 11. Guest Subscriber profile configuration access.
Figure 13. Edit Profile access to Apex Classes, Custom Objects and Named Credentials.
Figure 14. Sharing Rule example.
Figure 18. Selecting the site in the API Curator.
Figure 19. Adding your product/asset to your portal.
Figure 20. Checking that the product/asset has been added to the site.
Figure 21. API Access Requester is put in the API detail page.