activate()

!This function is available in versions 3.2.3 and later. In versions 3.2.2 and earlier, use activatePK() instead.

The activate function is used to activate a MIPAR API license key using the command line.

Arguments

Args:
productKey: MIPAR API product key or path to a .v2c license file, formatted as a string.

Returns:
errorStatus: dictionary that contains the errorFlag and errorMessage
flag: 0 - no error, 1 - an error occurred
message: error string of error that occurred during activation 

Syntax

errorStatus = mipar.activate(productKey)

Example

# initialize engine and licence manager
import miparAPI
mipar = miparAPI.initialize()
productKey = r'12345678-abcd-1234-abcd-123456789101'  
errorStatus = mipar.activate(productKey)
# or
productKey = r'directory/apiKey.v2c'
errorStatus = mipar.activate(productKey)