Retrieve API product settings using GetAPIProduct

This policy specifies an API product name and returns the complete profile and settings for an API product. Use the GetAPIProduct policy when you need access to API product settings (usually Quota settings) when no security policy (API key or OAuth) is enforced.

API products can be access statically, by setting the API product name as the element value.

For example:

<GetAPIProduct name="GetProductProfile">
    <APIProduct>PremiumAPIProduct</APIProduct>
</GetAPIProduct>

Usually, however, an API product must be retrieved dynamically, based on a variable associated with a request.

For example:

<GetAPIProduct name="GetProductProfile">
    <APIProduct ref="{variable_name}" /> 
</GetAPIProduct>

When the GetAPIProduct policy executes, a set of variables are populated with values for the API product retrieved.

The variables have the following prefix:

“getapiproduct.{policy_name}”

With reference to the sample policies above, the variables would have the form:

getapiproduct.GetProductProfile.apiproduct.name

The following variables are populated on successful execution of the GetAPIProduct policy: