Sources

Sources can be connected to any data source (hence the name) that you wish to meter and use for analytics or monetization. Sources are added to Products to apply pricing plans for customers.

Overview

In Revenium, sources are used as either billable metrics for Products, or to represent API endpoints for which Revenium will generate analytics (or both if you are monetizing API endpoints).

Required Product Attributes

Attribute	Usage
Name	The name you wish to use for analytics & reporting purposes. This name will appear in customer-facing notifications, invoices, and storefronts.
Type	API: used for API use cases ( you will typically define your source by a resource & method) Custom: for non-API usage-based metering & billing. In this case, you will define your source with an identifier issued by your application (and store this in the "Resource" field in Revenium)
Resource	For API use cases, choose the pattern matching desired (i.e. "equals," "begins with", etc.) and the pattern for URI/URL used by the source.
Method	This defaults to "ANY" meaning that all methods will be metered the same (i.e. PUT, GET, POST). If you wish to meter specific methods differently, you can do so by defining specific methods in separate Sources in Revenium.

Attribute

Usage

Name

The name you wish to use for analytics & reporting purposes. This name will appear in customer-facing notifications, invoices, and storefronts.

Type

API: used for API use cases ( you will typically define your source by a resource & method)
Custom: for non-API usage-based metering & billing. In this case, you will define your source with an identifier issued by your application (and store this in the "Resource" field in Revenium)

Resource

For API use cases, choose the pattern matching desired (i.e. "equals," "begins with", etc.) and the pattern for URI/URL used by the source.

Method

This defaults to "ANY" meaning that all methods will be metered the same (i.e. PUT, GET, POST). If you wish to meter specific methods differently, you can do so by defining specific methods in separate Sources in Revenium.

Optional Attributes

Version: if you wish to match your source versioning to an API version in your gateway, you can define it here. Note that several of our integrations require the format x.x.x, so this format is enforced by the application.
Elements: Define any Metering Elements that must be tracked during usage of this source.
External ID: This field is used to map this source to an identifier in an external system, often an external API gateway. This is used for certain commerce portal scenarios and can be ignored if there is no need to sync with an external system.
Environment: Only used for sources that have been copied to Revenium from an external system, and in this case the value will be populated automatically.
External Source ID: This is used if usage of an source will be synchronized to an external CRM or ERP, and you require an identifier that is consistent across both systems for internal reporting purposes.
Tags: use as needed for your own purposes.
Source Description: This description is used in linked commerce portals to provide API Subscribers a description of the purpose of the API. This field has no effect if not using a linked commerce portal.
Dev Portal Link: This field is used by some of Revenium's front-end integrations to provide a button that will link directly to a separate dev portal so that developers can view detailed documentation, mocking services, etc. If you are not using a front-end developer portal, this field has no function. Lastly, note that this field is not used with MuleSoft's developer portal.
Logo: This image is used by Revenium's front-end integrations to provide an image for each source in developer portals. If you are not using a front-end developer portal, this field has no function.

Last updated 3 months ago