Skip to content
API Reference/
Non-Session Access Reques...
/
Access request for elasti...

Dynamic Monetization APIs (1.0)

APIs to perform Dynamic Monetization activity.

Download OpenAPI description
OpenAPISpec.json
OpenAPISpec.yaml
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

Sessions

APIs for elastic access within the context of a session.

Operations

Non-Session Access Request

APIs for elastic access without a session.

Operations

Access request for elastic tokens

Request

API to request products, features or other items that will be charged for using elastic tokens.

Security
AdministrationAccess or ClientAccess
Path
instanceIdstring(uuid)required

The UUID of the Dynamic Monetization instance.

Bodyapplication/jsonrequired

The information required in the request payload.

requesterobject(Requester)required

Requester details.

requester.​typestringrequired

Type of the requester.

requester.​valuestringrequired

Unique identifier for the requester.

requester.​dictionaryobject

Dictionary of additional information about the requester. Will be used to evaluate actions defined on line items.

requestedItemsArray of objects(RequestedItemRequest)required

A list of requested items.

requestedItems[].​itemstringrequired

The requested item.

requestedItems[].​versionstring

The version of the item requested. This field may only be omitted or left blank if the intention is to access an item in a rate table with an empty or unspecified version.

requestedItems[].​countnumber(double)required

Number of instances of the requested item required. The value can be fractional.

requestedItems[].​metaDataobject(metaData)

(Optional) For sending custom data with the request, which will be sent to the data warehouse with the usage information to assist with analyzing access activity. The meta data content must be a valid JSON object.

curl -i -X POST \
  'https://{siteid}.flexnetoperations.{domainextension}/dynamicmonetization/elastic/api/v1.0/instances/{instanceId}/access-request' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "requester": {
      "type": "string",
      "value": "string"
    },
    "requestedItems": [
      {
        "item": "string",
        "version": "string",
        "count": 0.1,
        "metaData": {}
      }
    ]
  }'

Responses

OK The request succeeded in its entirety

Bodyapplication/json
requestedItemsArray of objects(RequestedItem)

List of requested items.

requesterobject(Requester)

The details of the requester making the access request.

correlationIdstring(CorrelationId)

An ID for the request, generated by the service, which allows correlation of the request with usage information obtained from the data warehouse.

Response
application/json
{
  "requestedItems": [
    { … }
  ],
  "requester": {
    "type": "string",
    "value": "string"
  },
  "correlationId": "string"
}

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