Skip to content
Last updated

Using the REST APIs

This section provides an overview of the REST APIs used by Dynamic Monetization. It also introduces the Try It feature, which lets you interact with the APIs directly from this documentation to understand and validate available endpoints.

Dynamic Monetization REST API Groups

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.

Base URL for Dynamic Monetization REST APIs

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".

Time Fields in Dynamic Monetization

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.

Configuration Values in Dynamic Monetization

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.

Getting the 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.

Modifying the Configuration

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.

Configurable Values

You can configure the following values.

Configuration ValueDescriptionDefault Setting
timezone.tolerantAllows 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 has a negative consequence for producers, who will be extending the life of a line item by a complete day in total. The benefit to producers, however, is that their customers have a good experience, with no interruption to their productivity even when they are located in the extreme timezones at +12 and -12 hours from UTC.

Supported values: true (enabled) and false (disabled).
false

Test APIs with Try It

The Try It feature allows you to send API requests directly from this API reference documentation, to explore and validate API endpoints.

With Try It, you can:

  • Modify any field in example requests
  • Save requests and review previous calls in the request history
  • Configure multiple environments with customizable variables
  • Send requests to live servers, the built‑in mock server, or other configured environments
  • Use realistic mock responses during API integration

Accessing Try It

You can open Try It from the API reference by selecting Try it on an endpoint.

When Try It opens, it appears as an overlay on top of the documentation page you were viewing. The interface is divided into two main sections:

  • Request
  • History

Working with Environments

Environments combine a server URL with predefined inputs, allowing you to make API calls using a consistent configuration.

Adding a New Environment

Create a new environment where you replace the variable siteID with your FlexNet Operations instance.

To create a new environment:
  1. Click the Environments icon selectenvironment.png in the top-right corner of Try It.
  2. In the Environments window, click New environment.
  3. Enter a name and confirm.
  4. In the Server field, open More options (three dots) and select Edit.
  5. Enter the server URL and save your changes.
  6. Optional configuration: In the Inputs table, you can:
    • Add new inputs and assign values
    • Update existing input values
    • Mark inputs as secret
    • Remove inputs you added

Editing Environment Settings

You can update any environment you create to better match your needs:

  • Rename the environment using the Edit icon
  • Change the server URL from the Server field
  • Define or update server variable values
  • Manage inputs by adding, editing, hiding, or removing them

Setting an Active Environment

One environment can be marked as active. By default, all requests are sent to the active environment.

To set an environment as active:
  1. Click the Environments icon selectenvironment.png.
  2. In the Environments window, hover over the environment's More options menu.
  3. Select Set as active.

Switching environments

To test requests against a different environment:
  1. Open the environment selector in the top-right corner of Try It.
  2. Choose the environment you want to use.

Deleting an Environment

You can permanently delete environments that you created.

To delete an environment:
  1. Click the Environments icon selectenvironment.png.
  2. In the Environments window, locate the environment you want to remove.
  3. Open More options and select Remove environment.

Using the Request Panel

The Request panel is displayed on the left side of the Try It interface. It contains all the controls needed to configure and send a request for a selected endpoint.

Sending a Request

To send a request:
  1. Provide values for the required parameters.
  2. Select Send.

Viewing Responses

After sending a request, a response preview appears at the bottom of the Request panel.

The response preview may include:

  • HTTP status code, response time, and payload size
  • Response body in JSON, plain text, HTML, or XML format
  • Response headers and their values
  • Response cookies

You can copy the response by selecting the Copy icon on the right side of the response area.

Adding Requests

You can add requests to the Request panel to access frequently used requests. All requests are displayed as tabs.

To add a request:
  1. At the top of the Request panel, click the + icon and click New Request.
  2. With the New Request tab selected, click the + icon again and select an endpoint from the list.

Using the History panel

Try It keeps a record of the requests you send, making it easy to revisit earlier API calls.

The History panel shows:

  • Requests listed from newest to oldest
  • Requests grouped by date
  • The response status code for each request

Searching the Request History

You can search the request history using the search field at the top of the History panel. Searches can match:

  • HTTP methods (for example, GET or POST)
  • Text from the request payload

Clearing the Request History

You can remove individual requests or clear the entire history:

  • To delete a single request, hover over it and select the trash icon
  • To clear all history, select the broom icon next to the search field

Collapsing the History Panel

To improve usability on smaller screens, you can hide the History panel.

Select the Collapse panel button in the bottom-left corner of the Try It interface.

Returning to the API Reference

Close Try It using the X icon in the top-left corner of the Request panel to return to the documentation.