Skip to content
API Reference/
/
Save a client key

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

Save a producer administration key

Request

Adds or updates a public key which can be used by a producer user to make Dynamic Monetization API requests. Allow 10 minutes for the key to be available to authorize requests.

Security
AdministrationAccess
Bodyapplication/jsonrequired

The request payload.

Array [
publicKeystring

A public key in PEM format.

Example: "-----BEGIN PUBLIC KEY-----\\nMIIBgjAcBgoqhkiG9w0BD...\\n-----END PUBLIC KEY-----"
idstring

Your identifier for the key. This identifier must be added as a claim in a JWT token signed with the corresponding private key, in order to indicate which public key should be used to verify the JWT is valid.

Example: "xyz"
]
curl -i -X PUT \
  'https://{siteid}.flexnetoperations.{domainextension}/dynamicmonetization/api/v1.1/administration-keys' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "publicKey": "-----BEGIN PUBLIC KEY-----\\nMIIBgjAcBgoqhkiG9w0BD...\\n-----END PUBLIC KEY-----",
      "id": "xyz"
    }
  ]'

Responses

OK. The request succeeded in its entirety.

Delete a producer administration key

Request

Deletes a specified producer administration key. Pass the ID of the key that you want to delete as a path parameter. It may take up to 10 minutes for the key to be fully removed after calling the API.

Security
AdministrationAccess
Path
keyIdstringrequired

Public key ID.

curl -i -X DELETE \
  'https://{siteid}.flexnetoperations.{domainextension}/dynamicmonetization/api/v1.1/administration-keys/{keyId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK. The request succeeded in its entirety.

Save a client key

Request

Adds or updates a public key which can be used by a client user to make Dynamic Monetization API requests. Allow 10 minutes for the key to be available to authorize requests.

Security
AdministrationAccess
Bodyapplication/jsonrequired

The request payload.

Array [
publicKeystring

A public key in PEM format.

Example: "-----BEGIN PUBLIC KEY-----\\nMIIBgjAcBgoqhkiG9w0BD...\\n-----END PUBLIC KEY-----"
idstring

Your identifier for the key. This identifier must be added as a claim in a JWT token signed with the corresponding private key, in order to indicate which public key should be used to verify the JWT is valid.

Example: "xyz"
]
curl -i -X PUT \
  'https://{siteid}.flexnetoperations.{domainextension}/dynamicmonetization/api/v1.1/client-keys' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "publicKey": "-----BEGIN PUBLIC KEY-----\\nMIIBgjAcBgoqhkiG9w0BD...\\n-----END PUBLIC KEY-----",
      "id": "xyz"
    }
  ]'

Responses

OK. The request succeeded in its entirety.

Delete a client key

Request

Deletes a specified client key. Pass the ID of the key that you want to delete as a path parameter. It may take up to 10 minutes for the key to be fully removed after calling the API.

Security
AdministrationAccess
Path
keyIdstringrequired

Public key ID.

curl -i -X DELETE \
  'https://{siteid}.flexnetoperations.{domainextension}/dynamicmonetization/api/v1.1/client-keys/{keyId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK. The request succeeded in its entirety.

Get a list of public keys

Request

Gets a list of administration and client public keys.

Security
AdministrationAccess
Query
nextinteger>= 0

Enter the next page value returned by the response to the previous GET /public-keys request to get the next batch of public keys.

sizeinteger[ 1 .. 100 ]

Number of keys to fetch.

curl -i -X GET \
  'https://{siteid}.flexnetoperations.{domainextension}/dynamicmonetization/api/v1.1/public-keys?next=0&size=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK. The request succeeded in its entirety.

Bodyapplication/json
keysArray of objects(PublicKey)

The public keys.

nextinteger

Use this page value in your next GET /public-keys request to fetch the next batch of public keys.

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

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