Getting Started
Endpoint url: https://customerportal.innovatrics.com The API calls shall be authenticated using your customer portal credentials
Generated Licenses
Viewing Product Licenses:
Endpoint: /api/license/list
Method: GET
Response:
Status Code: 200 (OK)
Content-Type: application/json
Request:
No request parameters required.
Possible errors:
("Unauthorized", status=401)
Show Product License
Getting the details of a specific product license.
Endpoint: /api/license/show/<int:license_id>
Method: GET
Request Path Parameter:
license_id: The ID of the license to retrieve details for.
Response:
Status Code: 200 (OK)
Content-Type: application/json
Possible errors:
("Unauthorized", status=401)
("Not Found", status=404)
("Forbidden", status=403)
List License Details
Get a list of license details associated with the authenticated user.
Endpoint: /api/license-detail/list
Method: GET
Request:
No request parameters required.
Response:
Status Code: 200 (OK)
Content-Type: application/json
Possible errors:
("Unauthorized", status=401)
Show License Detail
Get details of a specific license .
Endpoint: /api/license-detail/show/<int:license_id>
Method: GET
Request Path Parameter:
license_id: The ID of the license to retrieve details for.
Response:
Status Code: 200 (OK)
Content-Type: application/json
Possible errors:
("Unauthorized", status=401)
("Not Found", status=404)
("Forbidden", status=403)
Credited Licenses
List Product Assignments
Get a list of product assignments associated with the authenticated user.
Endpoint: /api/product-assignment/list
Method: GET
Request:
No request parameters required.
Response:
Status Code: 200 (OK)
Content-Type: application/json
Show Product Assignment
Get details of a specific product assignment.
Endpoint: /api/product-assignment/show/<int:product_assignment_id>
Method: GET
Request:
Path Parameter: product_assignment_id: The ID of the product assignment
to retrieve details for.
Response:
Status Code: 200 (OK)
Content-Type: application/json
Possible errors:
("Unauthorized", status=401)
("Not Found", status=404)
("Forbidden", status=403)
List All Licenses grouped by Product Assignment
Get a list of licenses grouped by product assignments associated with the
authenticated user.
Endpoint: /api/license/product-assignment/list
Method: GET
Request:
No request parameters required.
Response:
Status Code: 200 (OK)
Content-Type: application/json
Possible errors:
("Unauthorized", status=401)
List Licenses by specific Product Assignment
Get a list of licenses associated with a specific product assignment.
Endpoint: /api/license/product-assignment/<int:assignment_id>
Method: GET
Request:
Path Parameter: assignment_id: The ID of the product assignment for which
to retrieve licenses.
Response:
Status Code: 200 (OK)
Content-Type: application/json
Possible errors:
("Unauthorized", status=401)
("Not Found", status=404)
("Forbidden", status=403)
Generate License
Generate a new license for a specific product assignment.
Endpoint: /api/license/generate/<int:product_assignment_id>
Method: GET
Request:
Path Parameter: product_assignment_id: The ID of the product assignment
for which to generate a license.
Query Parameters:
hwid: Hardware ID for the license.
expiration_date: Expiration date for the license (format: 'YYYY-MM-DD').
note: Optional note for the license.
Response:
Status Code: 200 (OK)
Content-Type: application/json
Possible errors:
("Unauthorized", status=401)
("Not Found", status=404)
("Forbidden", status=403)
("Please provide valid hardware ID", status=403)
("Please provide valid expiration_date format: '%Y-%m-%d'", status=403)
("Bad Request: %s" % e, 400) With Exception details.
Download License
Download the license file associated with a specific license detail.
Endpoint: /api/license-detail/download/<int:license_id>
Method: GET
Request:
Path Parameter: license_id: The ID of the license detail for which to download
the license file.
Response:
Status Code: 200 (OK)
Content-Type: application/json
Possible errors:
("Unauthorized", status=401)
("You cannot download licenses you don't have!", status=403)