API FRAMEWORK

Application API Services

REST Functions Available

We provide multiple API services to Kalipso and AMS applications thru application addon's. That way you can implement complicated functions with allmost no code at all. All the communications are fully encrypted and every function requires a token for each call increassing the api security.

Get the key numeric account code from the provided account credentials.


Entry Parameters : { "AccountPassword": "", "AccountUsername": "", "Customer": "", "LicensePassword": "", "LicenseUsername": "", "Product": "", "Token": "" }

Result : {"result":"false","error":"true","errormsg":"No error, code returned.","return":{"code":0}}

On Error :

Notes : No notes...

Returns if an account credentials are valid or not.


Entry Parameters : { "AccountPassword": "", "AccountUsername": "", "Customer": "", "LicensePassword": "", "LicenseUsername": "", "Product": "" }

Result : { "error": "false", "errormsg": "No error, account valid and returned.", "result": "true", "return": { "code": 0, "customer": "", "name": "", "password": "", "product": "", "role": 0, "username": "" } }

On Error :

Notes : If the provided credentials fail to check for 3 times the ip will be banned for 15 minutes.

Returns the key numeric account role code from the provided account credentials.


Entry Parameters :

Result :

On Error :

Notes :

Returns the key numeric customer code from the provided account credentials.


Entry Parameters :

Result :

On Error :

Notes :

Returns the database profile parameters from a given product


Entry Parameters :

Result :

On Error :

Notes :

Returns if a given device id is banned or not. This validation is made by the ip address.


Entry Parameters :

Result :

On Error :

Notes :

Sends an SMTP email using an SMTP account data.


Entry Parameters :

Result :

On Error :

Notes :

Checks if the API is active and working properly.


Entry Parameters :

Result :

On Error :

Notes :

Checks if a given license is valid or not.


Entry Parameters :

Result :

On Error :

Notes :

Returns the MIS profile parameter from a given product. This parameters are only applied to KAL applications.


Entry Parameters :

Result :

On Error :

Notes :

Returns the key numeric product code from the provided product name.


Entry Parameters :

Result :

On Error :

Notes :

Returns the product version from a given product name.


Entry Parameters :

Result :

On Error :

Notes :

Returns a token to be used on other requests.


Entry Parameters :

Result :

On Error :

Notes :

Registers a device on the database using a set of given parameters.


Entry Parameters :

Result :

On Error :

Notes :

Get the key numeric license code from the provided licensing credentials.


Entry Parameters : { "AccountPassword": "", "AccountUsername": "", "Customer": "", "LicensePassword": "", "LicenseUsername": "", "Product": "", "Token": "" }

Result : {"result":"false","error":"true","errormsg":"No error, code returned.","return":{"code":0}}

On Error :

Notes : No notes...