This section briefly describes the REST APIs that are used by Dynamic Monetization.
APIs are grouped by their functionality:
- Authorization—API for producer users to manage authorization keys.
- Instances—Producers use these APIs to manage the instances available for customers.
- Rate Tables—Producers use these APIs to set up and manage their rate tables.
- Line Items—APIs to manage line items present on instances.
- Rules of Access—APIs to manage rules of access for Dynamic Monetization instances. Rules of access are used to control the way the counts of an elastic line item are used in an access request.
- Sessions—The client application calls these APIs to request products, features or other items that will be charged for using Elastic tokens. These APIs let you do the following:
- Request access to items available in the rate tables
- Creating a session
- Control sessions and the items that are charged for within the sessions.
- Making an access request as part of a session
- Sending a heartbeat to keep the session active
- Deleting a session
- Non-Session Access Requests—Used by your deployed software for one-off access request to use items.
- Configuration—APIs for defining configuration values that control how customers can access and consume line items.
To use the REST APIs, choose the URL applicable to your FlexNet Operations instance:
https://<siteID>-uat.flexnetoperations.com/dynamicmonetization/https://<siteID>-uat.flexnetoperations.eu/dynamicmonetization/
where <siteID> is your organization's site ID supplied by Revenera.
For production environments, omit “-uat”.
All times in Dynamic Monetization are handled as POSIX timestamps in milliseconds. That is, they represent the number of milliseconds since 1970-01-01 00:00:00 UTC.
Use the /configuration API to manage configuration values that control how your customers can access and consume line items.
This section provides only a short overview. For detailed information about the /configuration API, see the API Reference, section Configuration.
Send a GET request to /configuration to receive the current configuration. If any values have been modified, the response also includes details about the modification date and the token key ID that was used to change the value.
Send a PATCH request to /configuration to change any values. In the request body, specify the name and value parameters for the configuration value that you want to add or modify.
You can configure the following values.
| Configuration Value | Description | Default Setting |
|---|---|---|
| timezone.tolerant | Allows tokens to be consumed up to 12 hours before a line item's start date and up to 12 hours after its end date. This ensures that client applications can operate for a full day at the start of a line item no matter where they are located in the world; and that they can operate for a full day at the expiration of a line item no matter where they are in the world. Elastic Access has no knowledge of where the client software application is located. It is just “tolerant” by allowing all applications an extra half day at the start and expiration. Setting timezone.tolerant to true (enabled) and false (disabled). | false |