Anypoint API & API Group Synchronization
Last updated
Last updated
This configuration is only required if using Revenium's Drop-In Storefront for Mulesoft's Anypoint Community Manager (ACM).
Revenium supports API & API Group synchronization from Anypoint API Manager / Exchange to the Revenium platform for monetization.
The synchronization features enable subscribers browsing your API storefront to be routed seamlessly to the API details pages published in ACM when viewing a product bundle you have published for sale. (from the API details page in ACM, interested developers will find your API documentation, sample code, and an interactive console they can use to test integrations with your API).
This feature also allows Subscribers to view all product bundles you publish that provide access to a given API so that they can easily sign up and pay for access to the API (an example can be viewed in the image below).
To enable this feature, please follow these steps:
Go to the Community API Details page in your Community and look for the API Header component, once there, uncheck the Show API Access Requester option.
Drag & drop the Revenium Request Access from Source component into the section of this page where you want to show it.
As a starting point, please review the official Anypoint documentation to Create and Publish API Groups.
Within Revenium's configuration for a source, you can define an external ID that links back to MuleSoft Exchange. This allows the Revenium Drop-In Storefront to dynamically create links to the API details pages in ACM for customers who are browsing your API product documentation.
Before you can sync your data ensure the Anypoint account you're using is configured with the following API Manager permissions:
Once your permissions are set, the process of linking the Revenium & MuleSoft record is straight-forward. View the API source in exchange and copy the identifier from the URL into the source record in Revenium.
Next, paste this source into the source record in Revenium as shown below:
Sources can also be synchronized automatically from Anypoint API Manager to Revenium. This can be accomplished by tagging the Source with REVENIUM. Note that Sources sync'd in this manner will be created by the Revenium Subscriber account who initially configured the APIM configuration in Revenium's UI.
Because API Group publishing is detail-oriented, we've provided a step-by-step guide below explaining the steps required for API Groups in Exchange to appear dynamically in Revenium's Drop-In Storefront.
Create the API Group in API Manager. A version of the group name chosen here will be used as the external ID in the product configuration of Revenium. One important note is that all group names will be converted to lowercase, and any spaces in group names will be converted to dashes. From the example below, "Test Product" becomes 'test-product' for the external ID in Exchange and Revenium. Also note that the "API Group instance label" chosen below will be displayed to end subscribers when requesting access to your API product, so use a customer friendly name here (i.e. U.S. Instance or European Instance")\
Assign the APIs you wish to be a part of your product to the API Group in API Manager and click Save.\
With the newly-created API group opened in API manager, add an SLA Tier using the left side menu as shown in the image below. Name & describe your SLA, and choose the approval method appropriate for your use case. Note that assigning SLAs is MuleSoft best practice and also required for successful use of Revenium's storefront components.
Return to the "Group Details" tab from the left side navigation menu. From this page, click "Publish to Exchange." \
When complete, click the link to view your product in Exchange. At this point, you will be able to view the external ID required for linking your Revenium storefront in the URL** ** (found in the blue box in the example image below) \
Next, return to Revenium and create a new product. A summary of the required steps is laid out below. Pay careful attention to the requirement to add the external ID to the product where indicated, which in the case of this example is "test-product".
Revenium will always use the latest API Group version published to Exchange.
If the Revenium Metering Policy is configured as an Automated Policy the URL/URI defined in the Revenium Sources must be unique. If the Source are being synchronized from the Anypoint Platform then the "Subscriber Endpoint" should be set the appropriate unique URI.
Once the API Groups are created and published, to set up the synchronization, select "Products" from the navbar on the left-hand side of the screen:
Next, you can either select an existing Product to edit it or click on the "Plus" button from the upper right-hand side of the UI to create a new one:
Once the Product form is open, go to the "Options" tab and fill the External ID field with the API Group ID:
Lastly, remember that for any Revenium products to be visible in third party portals, the option to "publish to commerce" portal must be selected when configuring the product in Revenium (shown below).
