Skip to main content
API docs by Redocly

License Manager (1.0)

Download OpenAPI specification:Download

DESC

license

List licenses.

Authorizations:
JWT
query Parameters
size
integer <int64>
Default: 50

Amount of items returned per pagination page

page
integer <int64>
Default: 0

Pagination page starting from 0

sort
string
Example: sort=createDate,desc

Sort list results Format: entity_field_name,order. Format entity collection: entity_sub_object_name.sub_field_name,order.

customerId
string
Example: customerId=431b946a-92ea-430a-984d-c3cd65d2bb77

Filter results by customerId

id
string

Filter results by id

createDate
integer <uint64>
Example: createDate=createDate=XXXX< will return result after XXXX, createDate=<XXXX will return result before XXXX, createDate=XXXX<<YYYYY will return result between XXXX and YYYY

Filter by create date. You can use date ranges by using < or << operator

updateDate
integer <uint64>

Filter by create date. You can use date ranges by using < or << operator (the same behavior as for createDate)

status
string
Example: status=Running, Paused, Expired, Canceled

Filter result by status

product
string
Example: product=product.id, product.name

Filter by product and its subfields example subfields: id, licenseProviderDefinitionId, publisherProductId, name

endUser
string
Example: endUser=endUser.lastName, endUser.city

Filter by endUser and its subfields example subfields: firstName, lastName, email, city, zipCode, country, locale

checkout
string
Example: checkout=checkout.orderId, checkout.orderLineId

Filter by checkout and its subfields example subfields: orderId, orderLineId

Responses

Response samples

Content type
application/json
{
  • "format": "short",
  • "items": [
    ],
  • "last": false,
  • "number": 41,
  • "size": 10,
  • "totalItems": 100523,
  • "totalPages": 10053
}

Update license.

Authorizations:
JWT
path Parameters
id
required
string

Entity id generated and returned in "Location" header upon creation (POST).

Request Body schema: application/json
object

Additional data about the license. ex: publisher-specific, fulfillment ids etc

object (Checkout)
closeLicenseExpirationJobDone
boolean

boolean flag indicating if tasks related to license's upcoming expiration has been finished

createDate
integer <int64>

Entity creation time. Value is auto generated upon creation and read only. Timestamp in milliseconds.

customerId
string

Associates entity to certain customer.

dbVersion
integer <int64>

Concurrent operations check mechanism.

Used in update actions. Value is auto generated upon creation/update and read only.

Prevent for any issue during concurrent update transaction done by parallel applications. Upon spotted dbVersion incorrectness a 412 retry error is returned. Let's consider a scenario where two application are trying update same entity:

App 1: GET entity request at 00:00:00.000 Received dbVersion=0 change entity data PUT entity request at 00:00:00.009 updated automatically dbVersion=1

App 2: GET entity request with at 00:00:00.005 Received dbVersion=0 because update of App 1 haven't occurred yet change entity data update entity at 00:00:00.014 412 Error, because dbVersion=1 after update of App 1

expirationTimestamp
integer <int64>

license expiration date

id
string

Entity id. Value is auto generated upon creation and read only.

lastFailureTimestamp
integer <int64>

Info about failure, if not present, it means that the error did not occur

Array of objects (OperationExecution)

List of operations performed on license

processingInProgress
boolean

boolean flag indicating if license is currently being processed

object (Product)
status
string
updateDate
integer <int64>

Entity update time. Value is auto generated upon creation/update and read only. Timestamp in milliseconds.

object (User)

Responses

Request samples

Content type
application/json
{
  • "additionalData": {
    },
  • "checkout": {
    },
  • "closeLicenseExpirationJobDone": true,
  • "createDate": 1593683684789,
  • "customerId": "e0436791-5866-406d-b0c8-3ba32ead438a",
  • "dbVersion": 0,
  • "expirationTimestamp": 0,
  • "id": "d87e0973-980a-4485-a39d-682184a8988a",
  • "lastFailureTimestamp": 0,
  • "operationExecutions": [
    ],
  • "processingInProgress": true,
  • "product": {
    },
  • "status": "Running, Canceled, Scheduled, Expired",
  • "updateDate": 1593685645385,
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "additionalData": {
    },
  • "checkout": {
    },
  • "closeLicenseExpirationJobDone": true,
  • "createDate": 1593683684789,
  • "customerId": "e0436791-5866-406d-b0c8-3ba32ead438a",
  • "dbVersion": 0,
  • "expirationTimestamp": 0,
  • "id": "d87e0973-980a-4485-a39d-682184a8988a",
  • "lastFailureTimestamp": 0,
  • "operationExecutions": [
    ],
  • "processingInProgress": true,
  • "product": {
    },
  • "status": "Running, Canceled, Scheduled, Expired",
  • "updateDate": 1593685645385,
  • "user": {
    }
}

Gets license.

Authorizations:
JWT
path Parameters
id
required
string

Entity id generated and returned in "Location" header upon creation (POST).

Responses

Response samples

Content type
application/json
{
  • "additionalData": {
    },
  • "checkout": {
    },
  • "closeLicenseExpirationJobDone": true,
  • "createDate": 1593683684789,
  • "customerId": "e0436791-5866-406d-b0c8-3ba32ead438a",
  • "dbVersion": 0,
  • "expirationTimestamp": 0,
  • "id": "d87e0973-980a-4485-a39d-682184a8988a",
  • "lastFailureTimestamp": 0,
  • "operationExecutions": [
    ],
  • "processingInProgress": true,
  • "product": {
    },
  • "status": "Running, Canceled, Scheduled, Expired",
  • "updateDate": 1593685645385,
  • "user": {
    }
}

Deletes license.

Authorizations:
JWT
path Parameters
id
required
string

Entity id generated and returned in "Location" header upon creation (POST).

Responses

Response samples

Content type
application/json
{
  • "error": "Unauthorized",
  • "message": "Unauthorized",
  • "path": "/service-name/resource/36a6d3ac-207f-4b64-be01-664c1edbd38b",
  • "status": 401,
  • "timestamp": 1593769514607
}

license-provider-definitions

List License Provider Definition.

Authorizations:
JWT
query Parameters
size
integer <int64>
Default: 50

Amount of items returned per pagination page

page
integer <int64>
Default: 0

Pagination page starting from 0

sort
string
Example: sort=createDate,desc

Sort list results Format: entity_field_name,order. Format entity collection: entity_sub_object_name.sub_field_name,order.

customerId
string
Example: customerId=431b946a-92ea-430a-984d-c3cd65d2bb77

Filter results by customerId

name
string

Filter results by License Provider Definition name

baseUrl
string

Filter results by license related requests

status
string

Filter results by status example Enable, Disable, TestMode

createDate
integer <uint64>
Example: createDate=createDate=XXXX< will return result after XXXX, createDate=<XXXX will return result before XXXX, createDate=XXXX<<YYYYY will return result between XXXX and YYYY

Filter by create date. You can use date ranges by using < or << operator

updateDate
integer <uint64>

Filter by create date. You can use date ranges by using < or << operator (the same behavior as for createDate)

Responses

Response samples

Content type
application/json
{
  • "format": "short",
  • "items": [
    ],
  • "last": false,
  • "number": 41,
  • "size": 10,
  • "totalItems": 100523,
  • "totalPages": 10053
}

Update license provider definition.

Authorizations:
JWT
path Parameters
id
required
string

Entity id generated and returned in "Location" header upon creation (POST).

Request Body schema: application/json
baseUrl
string

Base url of for license related requests

bodyType
string

Body type

createDate
integer <int64>

Entity creation time. Value is auto generated upon creation and read only. Timestamp in milliseconds.

customerId
string

Associates entity to certain customer.

dbVersion
integer <int64>

Concurrent operations check mechanism.

Used in update actions. Value is auto generated upon creation/update and read only.

Prevent for any issue during concurrent update transaction done by parallel applications. Upon spotted dbVersion incorrectness a 412 retry error is returned. Let's consider a scenario where two application are trying update same entity:

App 1: GET entity request at 00:00:00.000 Received dbVersion=0 change entity data PUT entity request at 00:00:00.009 updated automatically dbVersion=1

App 2: GET entity request with at 00:00:00.005 Received dbVersion=0 because update of App 1 haven't occurred yet change entity data update entity at 00:00:00.014 412 Error, because dbVersion=1 after update of App 1

fillWithGeneric
boolean

if true, license will be filled with generic request/response payload for fulfillment

object (HttpClientConfiguration)
id
string

Entity id. Value is auto generated upon creation and read only.

name
required
string

License Provider Definition name Name must be unique

required
object
object (PermanentErrorsDefinition)
status
string

fulfillment definition status

supportedOperations
Array of strings

Operations which can be performed about a single license.

object (TestModeParameters)
updateDate
integer <int64>

Entity update time. Value is auto generated upon creation/update and read only. Timestamp in milliseconds.

Responses

Request samples

Content type
application/json
{
  • "baseUrl": "https://api.nexway.store/license-keys-provider/client/xxx/licenses",
  • "bodyType": "json; xml",
  • "createDate": 1593683684789,
  • "customerId": "e0436791-5866-406d-b0c8-3ba32ead438a",
  • "dbVersion": 0,
  • "fillWithGeneric": true,
  • "httpClientConfiguration": {
    },
  • "id": "d87e0973-980a-4485-a39d-682184a8988a",
  • "name": "test-ManuallyCreatedGenericLicenseProvider",
  • "operationDefinitions": {
    },
  • "permanentErrorsDefinition": {
    },
  • "status": "Enable, Disable, TestMode (The testMode indicate to use the testModeParameters baseUrl and certificates and not the real one)",
  • "supportedOperations": "create; renew; pause; resume; cancel",
  • "testModeParameters": {
    },
  • "updateDate": 1593685645385
}

Response samples

Content type
application/json
{
  • "baseUrl": "https://api.nexway.store/license-keys-provider/client/xxx/licenses",
  • "bodyType": "json; xml",
  • "createDate": 1593683684789,
  • "customerId": "e0436791-5866-406d-b0c8-3ba32ead438a",
  • "dbVersion": 0,
  • "fillWithGeneric": true,
  • "httpClientConfiguration": {
    },
  • "id": "d87e0973-980a-4485-a39d-682184a8988a",
  • "name": "test-ManuallyCreatedGenericLicenseProvider",
  • "operationDefinitions": {
    },
  • "permanentErrorsDefinition": {
    },
  • "status": "Enable, Disable, TestMode (The testMode indicate to use the testModeParameters baseUrl and certificates and not the real one)",
  • "supportedOperations": "create; renew; pause; resume; cancel",
  • "testModeParameters": {
    },
  • "updateDate": 1593685645385
}

Creates license provider definition.

Authorizations:
JWT
Request Body schema: application/json
baseUrl
string

Base url of for license related requests

bodyType
string

Body type

customerId
string

Associates entity to certain customer.

fillWithGeneric
boolean

if true, license will be filled with generic request/response payload for fulfillment

object (HttpClientConfiguration)
name
required
string

License Provider Definition name Name must be unique

required
object
object (PermanentErrorsDefinition)
status
string

fulfillment definition status

supportedOperations
Array of strings

Operations which can be performed about a single license.

object (TestModeParameters)

Responses

Request samples

Content type
application/json
{
  • "baseUrl": "https://api.nexway.store/license-keys-provider/client/xxx/licenses",
  • "bodyType": "json; xml",
  • "customerId": "e0436791-5866-406d-b0c8-3ba32ead438a",
  • "fillWithGeneric": true,
  • "httpClientConfiguration": {
    },
  • "name": "test-ManuallyCreatedGenericLicenseProvider",
  • "operationDefinitions": {
    },
  • "permanentErrorsDefinition": {
    },
  • "status": "Enable, Disable, TestMode (The testMode indicate to use the testModeParameters baseUrl and certificates and not the real one)",
  • "supportedOperations": "create; renew; pause; resume; cancel",
  • "testModeParameters": {
    }
}

Response samples

Content type
application/json
{
  • "error": "Bad Request",
  • "message": "error: field can't be empty",
  • "path": "/service-name/resource/36a6d3ac-207f-4b64-be01-664c1edbd38b",
  • "status": 400,
  • "timestamp": 1593769514607
}

Gets license provider definition.

Authorizations:
JWT
path Parameters
id
required
string

Entity id generated and returned in "Location" header upon creation (POST).

Responses

Response samples

Content type
application/json
{
  • "baseUrl": "https://api.nexway.store/license-keys-provider/client/xxx/licenses",
  • "bodyType": "json; xml",
  • "createDate": 1593683684789,
  • "customerId": "e0436791-5866-406d-b0c8-3ba32ead438a",
  • "dbVersion": 0,
  • "fillWithGeneric": true,
  • "httpClientConfiguration": {
    },
  • "id": "d87e0973-980a-4485-a39d-682184a8988a",
  • "name": "test-ManuallyCreatedGenericLicenseProvider",
  • "operationDefinitions": {
    },
  • "permanentErrorsDefinition": {
    },
  • "status": "Enable, Disable, TestMode (The testMode indicate to use the testModeParameters baseUrl and certificates and not the real one)",
  • "supportedOperations": "create; renew; pause; resume; cancel",
  • "testModeParameters": {
    },
  • "updateDate": 1593685645385
}

Deletes license provider definitions.

Authorizations:
JWT
path Parameters
id
required
string

Entity id generated and returned in "Location" header upon creation (POST).

Responses

Response samples

Content type
application/json
{
  • "error": "Unauthorized",
  • "message": "Unauthorized",
  • "path": "/service-name/resource/36a6d3ac-207f-4b64-be01-664c1edbd38b",
  • "status": 401,
  • "timestamp": 1593769514607
}

operations

OperationExecutionId - for now i don`t know what it is :).

Authorizations:
JWT
path Parameters
id
required
string

Entity id generated and returned in "Location" header upon creation (POST).

operationExecutionId
required
string

OperationExecutionId - for now i don`t know what it is :).

Responses

Response samples

Content type
application/json
{
  • "additionalData": {
    },
  • "id": "string",
  • "processingData": {
    },
  • "replyContext": "string",
  • "request": {
    },
  • "requestTimestamp": 0,
  • "requestTrackingContext": {
    },
  • "status": "string",
  • "traces": [
    ]
}

You can replay only last operation on license if it is error.

Authorizations:
JWT
path Parameters
id
required
string

Entity id generated and returned in "Location" header upon creation (POST).

Responses

Response samples

Content type
application/json
{
  • "additionalData": {
    },
  • "id": "string",
  • "processingData": {
    },
  • "replyContext": "string",
  • "request": {
    },
  • "requestTimestamp": 0,
  • "requestTrackingContext": {
    },
  • "status": "string",
  • "traces": [
    ]
}

You can replay only last operation on license if it is error.

Authorizations:
JWT
path Parameters
id
required
string

Entity id generated and returned in "Location" header upon creation (POST).

Responses

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "license": {
    }
}

Will return license for this operation.

Authorizations:
JWT
Request Body schema: application/json
object
object (Checkout)
licenseId
string
noAutomaticRetry
boolean
operation
string
object (Product)
object (TestOperationParameters)

Transient

object (User)

Responses

Request samples

Content type
application/json
{
  • "additionalData": {
    },
  • "checkout": {
    },
  • "licenseId": "string",
  • "noAutomaticRetry": true,
  • "operation": "string",
  • "product": {
    },
  • "testModeParameters": {
    },
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "additionalData": {
    },
  • "checkout": {
    },
  • "closeLicenseExpirationJobDone": true,
  • "createDate": 1593683684789,
  • "customerId": "e0436791-5866-406d-b0c8-3ba32ead438a",
  • "dbVersion": 0,
  • "expirationTimestamp": 0,
  • "id": "d87e0973-980a-4485-a39d-682184a8988a",
  • "lastFailureTimestamp": 0,
  • "operationExecutions": [
    ],
  • "processingInProgress": true,
  • "product": {
    },
  • "status": "Running, Canceled, Scheduled, Expired",
  • "updateDate": 1593685645385,
  • "user": {
    }
}