Skip to content
API Reference/
/
All configuration

Dynamic Monetization APIs (v1.1)

APIs to perform Dynamic Monetization activity.

Download OpenAPI description
openapi-spec.json
openapi-spec.yaml
Languages
Servers
Dynamic Monetization API URL
https://{siteID}.flexnetoperations.{domainExtension}/dynamicmonetization/

Authorization

APIs to manage authorization keys.

Operations

Instances

APIs to manage Dynamic Monetization instances, which host the line items belonging to customers.

Operations

Line Items

APIs to manage line items mapped to an instance.

Operations

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.

Operations

Rate Tables

APIs to manage rate tables. Rate tables are used to define the price of items (how many tokens are charged per item).

Operations

Sessions

APIs for elastic access within the context of a session.

Operations

Non-Session Access Request

APIs for elastic access without a session.

Operations

Configuration

APIs for managing configuration values that control how customers can access and consume line items.

Available values:

  • timezone.tolerant
    • Allows a line item to be used up to 12 hours before its start date (UTC) and up to 12 hours after its end date (UTC), therefore making it tolerant to all time zones.
    • Supported values: true (enabled) and false (disabled).
    • Default: false
  • session.charge.period
    • Defines the automatic charge interval for a session. Consult the user guide for more information about session automatic charging.
    • Supported values: ISO-8601 duration in the form PTnH, PTnM, or PTnHnM. Seconds are not supported.
      • Examples:
        • PT1H is every hour
        • PT30M is every 30 minutes
        • PT1H30M is every 90 minutes
      • Minimum: 10 minutes
      • Maximum: 24 hours
    • Default: PT1H (every hour)
Operations

All configuration

Request

Returns all configured values. If a configuration has been modified, the response includes the date of modification and the token key ID that was used to change configuration.

Security
AdministrationAccess
curl -i -X GET \
  'https://{siteid}.flexnetoperations.{domainextension}/dynamicmonetization/provisioning/api/v1.1/configuration' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Configuration was successfully returned.

Bodyapplication/jsonArray [
namestring

The name of the configuration.

valuestring

The value of the configuration.

modifiednumberread-only

The date and time, in milliseconds since 1970-01-01 00:00 UTC, when the configuration was last modified. This field is returned only if the configuration has been changed from its default value.

updatedBystringread-only

Public key identifier of the JWT token that was used to update this configuration. This key ID allows you to identify the user or users who are authorized to make this change. This field is returned only if the configuration has been changed from its default value.

]
Response
application/json
[
  {
    "name": "string",
    "value": "string",
    "modified": 0,
    "updatedBy": "string"
  }
]

Update configuration

Request

Update one or more configuration values.

Security
AdministrationAccess
Bodyapplication/jsonArray [
namestring

The name of the configuration.

valuestring

The value of the configuration.

]
curl -i -X PATCH \
  'https://{siteid}.flexnetoperations.{domainextension}/dynamicmonetization/provisioning/api/v1.1/configuration' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "name": "string",
      "value": "string"
    }
  ]'

Responses

Configuration was saved successfully.