# Dynamic Monetization APIs APIs to perform Dynamic Monetization activity. Version: v1.1 ## Servers Dynamic Monetization API URL ``` https://{siteID}.flexnetoperations.{domainExtension}/dynamicmonetization ``` Variables: - `siteID`: Site ID for your Dynamic Monetization instance. Default: "siteID" - `domainExtension`: Domain extension for your Dynamic Monetization instance. Default: "com" ## Security ### AdministrationAccess [object Object],[object Object],[object Object],[object Object] Type: http Scheme: bearer Bearer Format: JWT ### ClientAccess [object Object],[object Object],[object Object],[object Object],[object Object] Type: http Scheme: bearer Bearer Format: JWT ### bearerAuth Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description - [Dynamic Monetization APIs](https://developer.revenera.com/_bundle/products/dynamicmonetization/apis/openapi-spec.yaml) ## Authorization - [PUT /api/v1.1/administration-keys](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/authorization/producer-admin-key-upload.md): Adds or updates a public key which can be used by a producer user to make Dynamic Monetization API requests. - [DELETE /api/v1.1/administration-keys/{keyId}](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/authorization/delete-producer-admin-key.md): 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. - [PUT /api/v1.1/client-keys](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/authorization/client-key-upload.md): Adds or updates a public key which can be used by a client user to make Dynamic Monetization API requests. - [DELETE /api/v1.1/client-keys/{keyId}](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/authorization/delete-client-key.md): 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. - [GET /api/v1.1/public-keys](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/authorization/get-public-keys.md): Gets a list of administration and client public keys. ## Instances - [GET /provisioning/api/v1.1/instances](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/instances/listinstances.md): 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. - [POST /provisioning/api/v1.1/instances](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/instances/addinstance.md): 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 Operati - [GET /provisioning/api/v1.1/instances/{instanceId}](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/instances/getinstancebyid.md): Returns information about a specific instance. Pass the instance ID for which you require information as a path parameter. ## Rate Tables - [POST /provisioning/api/v1.1/rate-tables](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/rate-tables/postratetables.md): Creates a new rate table. - [GET /provisioning/api/v1.1/rate-tables](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/rate-tables/getratetables.md): Gets all the rate tables, whether the effective time of the rate table has been reached or not. - [DELETE /provisioning/api/v1.1/rate-tables](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/rate-tables/deleteratetables.md): Deletes a rate table that hasn't come into effect yet. Note: Rate tables that are already in effect cannot be deleted. ## Line Items - [GET /provisioning/api/v1.1/instances/{instanceId}/line-items](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/line-items/getactivationsforinstance.md): Returns a list of line items mapped to instances owned by a producer's customer accounts. - [PUT /provisioning/api/v1.1/instances/{instanceId}/line-items](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/line-items/addactivation.md): Maps a line item to an instance. The first time this API is called, the payload details will be stored, and reported in a GET line-item request. If the line item is already mapped, then the details s - [GET /provisioning/api/v1.1/instances/{instanceId}/line-items/{lineItemId}](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/line-items/getlineitembyid.md): Returns information about a specific line item. Pass the line item ID for which you require information as a path parameter. - [DELETE /provisioning/api/v1.1/instances/{instanceId}/line-items/{lineItemId}](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/line-items/deletelineitem.md): Deletes a line item given its ID. This method is intended for use if you do not use FlexNet Operations as your back office, so that you can manage line items in Dynamic Monetization for your end cus ## Rules of Access - [POST /api/v1.1/instances/{instanceId}/line-items/{lineItemId}/actions](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/rules-of-access/createactions.md): Creates an ordered list of actions to be taken when a condition is met. - [DELETE /api/v1.1/instances/{instanceId}/line-items/{lineItemId}/actions](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/rules-of-access/deleteactions.md): Deletes all actions on a line item. - [GET /api/v1.1/instances/{instanceId}/line-items/{lineItemId}/actions](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/rules-of-access/getactions.md): Returns a list of actions to be taken when condition is met. - [PUT /api/v1.1/instances/{instanceId}/line-items/{lineItemId}/actions](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/rules-of-access/putactions.md): Modifies the list of actions for a line item. The existing actions can be re-ordered, modified or omitted, and new actions can be added to the list. If an action is omitted, it will be completely remo - [GET /api/v1.1/instances/{instanceId}/line-items/actions](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/rules-of-access/getlineitemactions.md): API to fetch all actions for all Elastic Access line items of the instance. - [GET /api/v1.1/instances/{instanceId}/conditions](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/rules-of-access/getconditionsofaccess.md): API to fetch conditions. - [POST /api/v1.1/instances/{instanceId}/conditions](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/rules-of-access/postconditionsofaccess.md): API to create conditions. - [PATCH /api/v1.1/instances/{instanceId}/conditions](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/rules-of-access/patchconditions.md): Update existing and add new conditions to an instance. - [DELETE /api/v1.1/instances/{instanceId}/conditions](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/rules-of-access/deleteconditionsofaccess.md): Delete all conditions configured on the instance. - [DELETE /api/v1.1/instances/{instanceId}/conditions/{conditionId}](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/rules-of-access/deleteconditionbyid.md): API to delete a specific condition configured on the instance. ## Consumption Limits - [PUT /api/v1.1/instances/{instanceId}/consumption-limits](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/consumption-limits/putinstanceconsumptionlimits.md): API to create or update consumption limits for an instance. - [GET /api/v1.1/instances/{instanceId}/consumption-limits](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/consumption-limits/getinstanceconsumptionlimits.md): API to retrieve the consumption limits applied to a specified instance. - [DELETE /api/v1.1/instances/{instanceId}/consumption-limits](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/consumption-limits/deleteinstanceconsumptionlimits.md): Delete all consumption limits applied to the specified instance. After this operation, consumption for the instance will no longer be restricted. Both the consumed figures and the requesters with limi - [GET /api/v1.1/instances/{instanceId}/consumption-limits/{consumptionLimitId}/requesters](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/consumption-limits/getinstancerequesterconsumptionlimits.md): Retrieves a list of all requesters being tracked against an instance's consumption limits, along with their respective consumption amounts. - [PUT /api/v1.1/instances/{instanceId}/line-items/{lineItemId}/consumption-limits](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/consumption-limits/putlineitemconsumptionlimits.md): API to create or update consumption limits for a line item. - [GET /api/v1.1/instances/{instanceId}/line-items/{lineItemId}/consumption-limits](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/consumption-limits/getlineitemconsumptionlimits.md): API to retrieve the consumption limits applied to a specified line item. - [DELETE /api/v1.1/instances/{instanceId}/line-items/{lineItemId}/consumption-limits](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/consumption-limits/deletelineitemconsumptionlimits.md): Delete all consumption limits applied to the specified line item. After this operation, consumption for the line item will no longer be restricted. Both the consumed figures and the requesters with li - [GET /api/v1.1/instances/{instanceId}/line-items/{lineItemId}/consumption-limits/{consumptionLimitId}/requesters](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/consumption-limits/getlineitemrequesterconsumptionlimits.md): Retrieves a list of all requesters being tracked against a line item's consumption limits, along with their respective consumption amounts. ## Sessions - [POST /api/v1.1/sessions](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/sessions/createsession.md): Creates a new session for elastic access. - [GET /api/v1.1/sessions](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/sessions/getallsessionsforinstance.md): Returns up to 100 live sessions, sorted in descending order of creation time. - [GET /api/v1.1/sessions/{sessionId}](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/sessions/getsession.md): Returns session details for the specified session ID. - [DELETE /api/v1.1/sessions/{sessionId}](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/sessions/closesession.md): Closes a specified session for elastic access. - [PUT /api/v1.1/sessions/{sessionId}](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/sessions/putsessionaccessrequest.md): Makes an elastic access request in the context of a session. - [GET /api/v1.1/sessions/{sessionId}/heartbeat](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/sessions/getheartbeat.md): Sends a heartbeat for a session to keep it active. ## Non-Session Access Request - [POST /elastic/api/v1.1/instances/{instanceId}/access-request](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/non-session-access-request/postaccessrequest.md): API to request products, features or other items that will be charged for using elastic tokens. ## Configuration - [GET /provisioning/api/v1.1/configuration](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/configuration/gettenantconfigurations.md): 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. - [PATCH /provisioning/api/v1.1/configuration](https://developer.revenera.com/products/dynamicmonetization/apis/openapi-spec/configuration/patchtenantconfigurations.md): Update one or more configuration values. Note: Configuration changes may take up to 5 minutes to take effect. Allow for this before making dependent requests to ensure updated values have been applied