Gravitee
The Gravitee Metering Plugin facilitates the capture of API transaction data flowing through Gravitee gateways for metering, monetization and chargeback.
Last updated
The Gravitee Metering Plugin facilitates the capture of API transaction data flowing through Gravitee gateways for metering, monetization and chargeback.
Last updated
© Revenium - www.revenium.io
The Gravitee Metering Plugin zip file can be obtained from the Revenium Customer Success team and installed in the following locations.
Gateway
/opt/graviteeio-gateway/plugins
Management API
/opt/graviteeio-management-api/plugins
The Metering Plugin is configured from the "Design" section of the Gravitee Management UI
The Revenium Metering Plugin can then be dragged into the Request and Response phases for the API:
Now you can configure the Metering Plugin. The only piece of required configuration is a Revenium API Integration Key.
The following table documents the full list of configuration parameters:
meteringUrl
no
The Revenium Metering API URL
apiKey
yes
The Revenium API Key
metadataExpression
no
An EL expression to extract additional metering metadata from the request.
meteringExpression
no
An EL expression to extract the metering id (header, etc) from the request.
activeMode
no
Actively reject API requests with invalid (expired, out of funds, etc) Subscription or Client ID headers
productLicenseCacheTTL
no
The amount of time to cache an valid Subscriptions
successExpression
no
An EL expression to determine whether or not the API response should be metered (default is to meter all 2xx series responses)