2.0.12 • Published 1 month ago
@ikonintegration/mod-license-client v2.0.12
module-license-client
License module nodejs API client
Overall
How to Use
import SMLicense from '@ikonintegration/mod-license-client';
const API = new SMLicense({
port: 9090, //isOptional
endpoint: SharedModules_LicenseEndpoint,
//Must be specified when using service routes
apiKey: config.examProvider.key, //API token on IDM.AppID format (generate from APIKey at https://runkit.com/gwdp/idm-appid-v1)
//Must be specified when using admin or user routes
authorizationToken: '', -- optional, IDM JWT for shared module admins and user routes -- Accepts a function to be called async and return the token
tenantID: ''
});
//Revoke License
const resp = await API.license.revokeLicense(ID);
if (!resp || resp.statusCode != 200) {
return ERROR:
} return SUCCESS;
Headers
The following header must be specified in every request!
- Authorization
Available API methods
Product:
- API.product.createProduct(productObj) - Admin only
- API.product.updateProduct(productObj) - Admin only
- API.product.deleteProduct(productID) - Admin only
- API.product.getProduct(productID) - Admin only
- API.product.getAllProducts() - Admin, users and services
Order:
- API.order.getProviderFromProduct(productObject) - Return provider from product
- API.order.isMonerisEnabledForProduct(productObject) - Return of Moneris is enabled for this provider.
- API.order.preOrder(orderObj) - Admin and users
- API.order.beginOrder(orderObj, provider) - Admin and users
- API.order.completeOrder(orderObj, provider) - Admin and users
- API.order.refundOrder(orderObj, provider) - Admin and users
- API.order.cancelOrder(orderObj, provider) - Admin and users
- API.order.getOrder(externalID, orderID) - Admin, users and services
- API.order.getOrdersByExternalID(externalID) - Admin, users and services
- API.order.getOrdersFromToTimestamp(from, to /timestamps/) - Admin and services
- API.order.getOrderReceipt(externalID, orderID) - Admin, users and services
- API.order.getPendingOrders() - Admin and services
- API.order.submitInvoiceOrder(orderObj) - Admin and services
- API.order.approveInvoiceOrder(orderObj) - Admin and services
- API.order.rejectInvoiceOrder(orderObj) - Admin and services
- API.order.getOrderByID(orderID) - Admin and services
License:
- API.license.redeemLicense(activationCode, productID) - Service only
- API.license.redeemLicenseByProduct(productID, externalID) - Service only
- API.license.revokeLicense(licenseID) - Admin only
- API.license.revokeLicenses(licenseIDs) - Admin only
- API.license.getLicenseByID(licenseID) - Admin, users and services
- API.license.getLicense(licenseID, externalID) - Admin, users and services
- API.license.getLicensesByExternalID(externalID) - Admin, users and services
- API.license.getLicensesByExternalIDs(externalIDs) - Admin and services
License Consumption:
- API.licenseConsumption.getLicenseConsumption(licenseID, consumptionID) - User, Admin and services
- API.licenseConsumption.getLicenseConsumptions(consumptionIDs) - User, Admin and services
Voucher:
- API.voucher.createVoucher(body, optionalVoucherID) - Admin only
- API.voucher.updateVoucher(body, voucherID) - Admin only
- API.voucher.deleteVoucher(voucherID) - Admin only
- API.voucher.getVoucher(voucherID) - Admin only
- API.voucher.verifyVoucher(voucherID) - Admin, users and services
- API.voucher.getVouchers() - Admin only
Key:
- API.key.getAvailableKeys(externalID, numberOfLicenses) - Admin, users and services
- API.key.getKey(activationKey) - Service only
Vault
- API.vault.getVaultNonce(externalID, userInfo) - Sysadmins, Admins and users (no services here)
- API.vault.setVaultDefaultPaymentMethod(paymentMethodNonce, externalID) - Sysadmins, Admins and users (no services here)
2.0.12
1 month ago
3.0.0-alpha4
1 month ago
2.0.11
2 months ago
2.0.9
2 months ago
2.0.10
2 months ago
3.0.0-alpha3
4 months ago
3.0.0-alpha2
4 months ago
2.0.8
8 months ago
3.0.0-alpha1
7 months ago
2.0.7
1 year ago
2.0.5
1 year ago
2.0.4
1 year ago
2.0.6
1 year ago
0.4.8
2 years ago
2.0.3
2 years ago
2.0.2
2 years ago
2.0.1
2 years ago
2.0.0
2 years ago
0.4.5
2 years ago
0.4.4
2 years ago
0.4.7
2 years ago
0.4.6
2 years ago
0.4.3
3 years ago
0.4.1
3 years ago
0.4.0
3 years ago
0.4.2
3 years ago
0.3.3
3 years ago
0.3.2
4 years ago
0.3.1
4 years ago
0.3.0
4 years ago
0.2.9
4 years ago
0.2.8
4 years ago
0.2.7
4 years ago
0.2.6
4 years ago
0.2.5
4 years ago
0.2.4
4 years ago
0.2.3
4 years ago
0.2.2
4 years ago
0.2.1
4 years ago
0.2.0
4 years ago
0.1.8
4 years ago
0.1.7
4 years ago
0.1.6
4 years ago
0.1.5
4 years ago
0.1.4
4 years ago
0.1.2
4 years ago
0.1.1
4 years ago
0.1.3
4 years ago
0.1.0
4 years ago