Skip to content
/Instances

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

Get a list of instances

Request

Returns information about instances owned by a producer's customer accounts.
Each customer account may have one or more instances, and each instance serves exactly one customer account.

Security
AdministrationAccess
Query
nextinteger

Enter the next page value returned by the response to the previous GET /instances request to get the next page of instances.

sizestring

Enter the number of items to return. (This number of items is not guaranteed.)

accountIdstring

Find instances belonging to this account ID. This query parameter must be used in combination with the 'default' query parameter.

defaultboolean

Find the default instance for the given account ID. Must be set to 'true'.

curl -i -X GET \
  'https://{siteid}.flexnetoperations.{domainextension}/dynamicmonetization/provisioning/api/v1.0/instances?next=0&size=string&accountId=string&default=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of instances was successfully returned.

Bodyapplication/json
contentArray of objects(Instance)

The list of instances.

nextinteger

Use this page value in your next GET /instances request to fetch the next page of instances.

Response
application/json
{
  "content": [
    { … }
  ],
  "next": 0
}

Create an instance

Request

Creates a new instance. Each customer account may have one or more instances, and each instance serves exactly one customer account.

This method is intended for use if you do not use FlexNet Operations as your back office, so that you can configure your upstream system (e.g. a CRM) to create instances for your accounts.

Security
AdministrationAccess
Bodyapplication/jsonrequired
shortNamestring[ 1 .. 100 ] charactersrequired

User-defined name of the instance.

accountIdstringnon-emptyrequired

ID of the customer account owning the instance.

curl -i -X POST \
  'https://{siteid}.flexnetoperations.{domainextension}/dynamicmonetization/provisioning/api/v1.0/instances' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "shortName": "string",
    "accountId": "string"
  }'

Responses

Successfully created an instance

Bodyapplication/json
idstringread-only

The ID of the instance.

shortNamestring[ 1 .. 100 ] charactersrequired

User-defined name of the instance.

accountIdstringnon-emptyrequired

ID of the customer account owning the instance.

defaultInstancebooleanread-only

Indicates whether this is the default instance for an account. If set to true, auto-provisioned line items will be mapped to this instance.

createdinteger(int64)read-only

The date and time the instance was created in milliseconds since 1970-01-01 00:00.

modifiedinteger(int64)read-only

The date and time the instance was last modified in milliseconds since 1970-01-01 00:00.

Response
application/json
{
  "id": "string",
  "shortName": "string",
  "accountId": "string",
  "defaultInstance": true,
  "created": 0,
  "modified": 0
}

Get instance by instance ID

Request

Returns information about a specific instance. Pass the instance ID for which you require information as a path parameter.

Security
AdministrationAccess
Path
instanceIdstring(uuid)required

The UUID of the Dynamic Monetization instance.

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

Responses

The instance was retrieved

Bodyapplication/json
idstringread-only

The ID of the instance.

shortNamestring[ 1 .. 100 ] charactersrequired

User-defined name of the instance.

accountIdstringnon-emptyrequired

ID of the customer account owning the instance.

defaultInstancebooleanread-only

Indicates whether this is the default instance for an account. If set to true, auto-provisioned line items will be mapped to this instance.

createdinteger(int64)read-only

The date and time the instance was created in milliseconds since 1970-01-01 00:00.

modifiedinteger(int64)read-only

The date and time the instance was last modified in milliseconds since 1970-01-01 00:00.

Response
application/json
{
  "id": "string",
  "shortName": "string",
  "accountId": "string",
  "defaultInstance": true,
  "created": 0,
  "modified": 0
}

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
Operations