Skip to content

Dynamic Monetization APIs (1.0)

APIs to perform Dynamic Monetization activity.

Download OpenAPI description
Languages
Servers
Dynamic Monetization API URL

https://{siteID}.flexnetoperations.{domainExtension}/dynamicmonetization/api/

Dynamic Monetization API URL

https://{siteID}.flexnetoperations.{domainExtension}/dynamicmonetization/floating/api/

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

Request

Gets all the rate tables created, whether the effective time of the rate table has been reached or not.

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

Responses

Rate tables with all their details were successfully returned.

Bodyapplication/json
createdinteger(int64)read-only

Creation time of the rate table in milliseconds since 1970-01-01 00:00.

effectiveFrominteger(int64)

Time when the rate table starts to take effect in milliseconds since 1970-01-01 00:00.

seriesstring

A means of grouping similar rate tables of different versions.

versionstring

The version of this rate table.

itemsArray of objects(RateTableItem)

List of rate table items.

Response
application/json
{ "created": 0, "effectiveFrom": 0, "series": "string", "version": "string", "items": [ {} ] }

Request

Creates a new rate table.

Security
AdministrationAccess
Bodyapplication/json
effectiveFrominteger(int64)

Time when the rate table starts to take effect in milliseconds since 1970-01-01 00:00.

seriesstring

A means of grouping similar rate tables of different versions.

versionstring

The version of this rate table.

itemsArray of objects(RateTableItem)

List of rate table items.

curl -i -X POST \
  'https://{siteid}.flexnetoperations.{domainextension}/dynamicmonetization/provisioning/api/v1.0/rate-tables' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "effectiveFrom": 0,
    "series": "string",
    "version": "string",
    "items": [
      {
        "name": "string",
        "version": "string",
        "rate": 0.1
      }
    ]
  }'

Responses

Rate table was successfully saved.

Bodyapplication/json
messagestring
Response
application/json
{ "message": "string" }

Request

Deletes a rate table that hasn't come into effect yet.

Note: Rate tables that are already in effect cannot be deleted.

Security
AdministrationAccess
Query
seriesstring

The series of the rate table. If not specified, only a rate table with no series would be deleted.

versionstringrequired

The version of the rate table.

curl -i -X DELETE \
  'https://{siteid}.flexnetoperations.{domainextension}/dynamicmonetization/provisioning/api/v1.0/rate-tables?series=string&version=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Rate table was successfully deleted.

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
Operations