Download OpenAPI specification:Download
APIs to perform Dynamic Monetization activity.
Adds or updates a public key which can be used by a producer user to make Dynamic Monetization API requests.
The request payload.
OK. The request succeeded in its entirety.
Bad Request. Check the request for any errors in the input.
Unauthorized. Check authentication details.
[- {
- "publicKey": "-----BEGIN PUBLIC KEY-----\\nMIIBgjAcBgoqhkiG9w0BD...\\n-----END PUBLIC KEY-----",
- "id": "xyz"
}
]
Deletes a specified producer administration key. Pass the ID of the key that you want to delete as a path parameter.
OK. The request succeeded in its entirety.
Bad Request. Check the request for any errors in the input.
Unauthorized. Check authentication details.
Forbidden. It is not possible to delete the last administration key. There must always be at least one key present.
Resource not found. The requested resource is not available.
Adds or updates a public key which can be used by a client user to make Dynamic Monetization API requests.
The request payload.
OK. The request succeeded in its entirety.
Bad Request. Check the request for any errors in the input.
Unauthorized. Check authentication details.
[- {
- "publicKey": "-----BEGIN PUBLIC KEY-----\\nMIIBgjAcBgoqhkiG9w0BD...\\n-----END PUBLIC KEY-----",
- "id": "xyz"
}
]
Deletes a specified client key. Pass the ID of the key that you want to delete as a path parameter.
OK. The request succeeded in its entirety.
Bad Request. Check the request for any errors in the input.
Unauthorized. Check authentication details.
Resource not found. The requested resource is not available.
Gets a list of administration and client public keys.
OK. The request succeeded in its entirety.
Bad Request. Check the request for any errors in the input.
Unauthorized. Check authentication details.
{- "keys": [
- {
- "id": "string",
- "type": "string",
- "publicKey": "string",
- "created": 0,
- "modified": 0
}
], - "next": 0
}
APIs to manage Dynamic Monetization instances, which host the line items belonging to customers.
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.
List of instances was successfully returned.
Bad Request. Check the request for any errors in the input.
Unauthorized. Check authentication details.
Forbidden. The user is forbidden from performing this operation. Check user permissions.
Resource not found. The requested resource is not available.
Internal Server Error. There was an internal error processing the request.
{- "content": [
- {
- "id": "string",
- "shortName": "string",
- "accountId": "string",
- "defaultInstance": true,
- "created": 0,
- "modified": 0
}
], - "next": 0
}
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.
Successfully created an instance
Bad Request. Check the request for any errors in the input.
Unauthorized. Check authentication details.
Forbidden. The user is forbidden from performing this operation. Check user permissions.
Internal Server Error. There was an internal error processing the request.
{- "shortName": "string",
- "accountId": "string"
}
{- "id": "string",
- "shortName": "string",
- "accountId": "string",
- "defaultInstance": true,
- "created": 0,
- "modified": 0
}
Returns information about a specific instance. Pass the instance ID for which you require information as a path parameter.
The instance was retrieved
Unauthorized. Check authentication details.
Resource not found. The requested resource is not available.
{- "id": "string",
- "shortName": "string",
- "accountId": "string",
- "defaultInstance": true,
- "created": 0,
- "modified": 0
}
Returns a list of line items mapped to instances owned by a producer's customer accounts.
List of line items for the instance ID.
Unauthorized. Check authentication details.
Resource not found. The requested resource is not available.
Internal Server Error. There was an internal error processing the request.
[- {
- "activationId": "string",
- "state": "string",
- "quantity": 1,
- "start": 0,
- "end": 0,
- "used": 0,
- "attributes": {
- "elastic": false,
- "rateTableSeries": ""
}
}
]
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 stored will be entirely replaced.
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 or back office) to create line items in Dynamic Monetization for your end customers. (If you use FlexNet Operations as your back office, but use this method directly to provision line items that do not exist in FlexNet Operations, then those line items will not be reflected in FlexNet Operations.)
Returned when a line item is successfully updated.
Returned when a line item is successfully created.
Bad Request. Check the request for any errors in the input.
Unauthorized. Check authentication details.
Forbidden. The user is forbidden from performing this operation. Check user permissions.
Internal Server Error. There was an internal error processing the request.
{- "activationId": "string",
- "state": "string",
- "quantity": 1,
- "start": 0,
- "end": 0,
- "attributes": {
- "elastic": false,
- "rateTableSeries": ""
}
}
"string"
Returns information about a specific line item. Pass the line item ID for which you require information as a path parameter.
The requested line item was found and returned successfully.
Bad Request. Check the request for any errors in the input.
Resource not found. The requested resource is not available.
Internal Server Error. There was an internal error processing the request.
{- "activationId": "string",
- "state": "string",
- "quantity": 1,
- "start": 0,
- "end": 0,
- "used": 0,
- "attributes": {
- "elastic": false,
- "rateTableSeries": ""
}
}
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 customers. (If you use FlexNet Operations as your back office, but use this method directly to remove line items that exist in FlexNet Operations, then those line items' representation in FlexNet Operations will not be affected.)
Line item was successfully un-mapped from the instance.
Forbidden. Line item must be in an OBSOLETE state before it can be deleted.
Line item is either not mapped to the instance, the instance does not exist, or the line item itself does not exist.
APIs to manage rate tables. Rate tables are used to define the price of items (how many tokens are charged per item).
Gets all the rate tables created, whether the effective time of the rate table has been reached or not.
Rate tables with all their details were successfully returned.
Unauthorized. Check authentication details.
Internal Server Error. There was an internal error processing the request.
{- "created": 0,
- "effectiveFrom": 0,
- "series": "string",
- "version": "string",
- "items": [
- {
- "name": "string",
- "version": "string",
- "rate": 0
}
]
}
Creates a new rate table.
Rate table was successfully saved.
Bad Request. Check the request for any errors in the input.
Unauthorized. Check authentication details.
Forbidden. The user is forbidden from performing this operation. Check user permissions.
Another rate table with the same version and series exists.
Internal Server Error. There was an internal error processing the request.
{- "effectiveFrom": 0,
- "series": "string",
- "version": "string",
- "items": [
- {
- "name": "string",
- "version": "string",
- "rate": 0
}
]
}
{- "message": "string"
}
Deletes a rate table that hasn't come into effect yet.
Note: Rate tables that are already in effect cannot be deleted.
Rate table was successfully deleted.
Rate table does not exist.
Rate table is already in effect.
Creates a new session for elastic access.
The information required in the request payload.
OK. The request succeeded in its entirety.
Bad Request. Check the request for any errors in the input.
Unauthorized. Check authentication details.
Internal Server Error. There was an internal error processing the request.
{- "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9"
}
{- "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}
Returns up to 100 live sessions, sorted in descending order of creation time.
OK. The request succeeded.
Bad Request. Check the request for any errors in the input.
Unauthorized. Check authentication details.
Internal Server Error. There was an internal error processing the request.
[- {
- "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",
- "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",
- "state": "IDLE",
- "chargedUntil": 0,
- "lastHeartBeat": 0,
- "lastAccessRequest": 0
}
]
Returns session details for the specified session ID.
OK. The request succeeded.
Bad Request. Check the request for any errors in the input.
Unauthorized. Check authentication details.
Resource not found. The requested resource is not available.
Internal Server Error. There was an internal error processing the request.
{- "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",
- "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",
- "state": "IDLE",
- "items": [
- {
- "item": "string",
- "version": "string",
- "count": 0
}
]
}
Closes a specified session for elastic access.
OK. The request succeeded in its entirety.
Bad Request. Check the request for any errors in the input.
Unauthorized. Check authentication details.
Resource not found. The requested resource is not available.
Resource conflict caused by another request that is using the same session. Try repeating the request; the session usually becomes free soon.
Internal Server Error. There was an internal error processing the request.
API is temporarily unavailable. Try again later.
Makes an elastic access request in the context of a session.
The information required in the request payload.
OK. The request succeeded in its entirety.
Bad Request. Check the request for any errors in the input.
Unauthorized. Check authentication details.
Forbidden. The operation might be forbidden due to an invalid JWT. If authorization is valid, this code is returned when the session is already terminated, the access request found rate tables but a requested item is not in them, or when insufficient counts are available to grant the request. These apply to an access request whether rollbackOnDeny is true or false.
Resource not found. The requested resource is not available.
Internal Server Error. There was an internal error processing the request.
API is temporarily unavailable. Try again later.
{- "requester": {
- "type": "string",
- "value": "string"
}, - "rollbackOnDeny": true,
- "requestedItems": [
- {
- "item": "string",
- "version": "string",
- "count": 0,
- "metaData": { }
}
]
}
{- "requestedItems": [
- {
- "count": 0,
- "item": "string",
- "version": "string",
- "totalTokensCharged": 0,
- "lineItems": [
- {
- "rate": 0,
- "activationId": "string",
- "tokensCharged": 0
}
], - "status": {
- "code": "string",
- "description": "Successfully checked out."
}
}
], - "requester": {
- "type": "string",
- "value": "string"
}, - "correlationId": "string"
}
Sends a heartbeat for a session to keep it active.
OK. The request succeeded.
Bad Request. Check the request for any errors in the input.
Unauthorized. Check authentication details.
Forbidden. The operation might be forbidden due to an invalid JWT. If authorization is valid, this code is returned when the session is already terminated.
Resource not found. The requested resource is not available.
Resource conflict caused by another request that is using the same session. Try repeating the request; the session usually becomes free soon.
Internal Server Error. There was an internal error processing the request.
API to request products, features or other items that will be charged for using elastic tokens.
The information required in the request payload.
required | object (Requester) Requester details. |
required | Array of objects (RequestedItemRequest) A list of requested items. |
OK The request succeeded in its entirety
Bad Request. Check the request for any errors in the input.
Unauthorized. Check authentication details.
Internal Server Error. There was an internal error processing the request.
API is temporarily unavailable. Try again later.
{- "requester": {
- "type": "string",
- "value": "string"
}, - "requestedItems": [
- {
- "item": "string",
- "version": "string",
- "count": 0,
- "metaData": { }
}
]
}
{- "requestedItems": [
- {
- "count": 0,
- "item": "string",
- "version": "string",
- "totalTokensCharged": 0,
- "lineItems": [
- {
- "rate": 0,
- "activationId": "string",
- "tokensCharged": 0
}
], - "status": {
- "code": "string",
- "description": "Successfully checked out."
}
}
], - "requester": {
- "type": "string",
- "value": "string"
}, - "correlationId": "string"
}
x-internal: true
APIs for managing configuration values that control how customers can access and consume line items.
Available values: