Product Information

When to use

Use this policy when you want to get the API product information

Details

API products are created in the API Collaborator component on Syvizo API Platform. When you want to apply a logic for request processing that needs information about a product, you can use “Product Information” policy. 

Based on the input parameters, the product information is returned 

Configuration

The configuration fields for the policy are:

[* Indicates a mandatory field]

Name *: Display name of the policy

Description: Description of policy

Enabled: Flag to indicate if the policy is enabled. If this field is not checked, the policy will be ignored at runtime and any fields from its output will contain a default initial value

Continue on Error: Flag to indicate that the flow should continue even if this policy throws an error

Input fields

appId: appId is usually sent in the request to identify which app the request has come from

productName: name of the product to get information

appName: Name of the app from which request has come

consumerKey: The key sent by consumer in request

Output fields

Returns a collection “products” of objects containing following properties

resources*: The paths or endpoints that are part of the product

approvalType: approval type of the API product

description: description of the product

quotaInterval: Interval for the quota checking for requests

quotaLimit: Number of requests allowed during the given interval

timeUnit: Time unit of the quota interval

class: Class of the product

creationTime: Date and time of product creation

createdBy: email id of the creator of the product

environments*: environment where the product is available

lastModifyTime: Last modification date and time of the product

lastModifyBy: Email id of the last modifier of the product