kerio-api

Ruby library that allows simple access to Kerio Technolgies products administration API (Control, Connect, Operator).

Usage

Kerio products implement API based on json-rpc protocol. Methods are grouped to interfaces and their names follow Interface.method convention. This API simulates an object-like interface following that convention.

Interfaces and methods itself are documented at Kerio website.

Examples

Print some Kerio Connect statistics

require 'kerio-api'
require 'uri'

mailserver = Kerio::Api::Client.new(url: URI.parse('https://localhost:4040/admin/api/jsonrpc/'))

mailserver.Session.login(
	userName: 'Admin',
	password: 'pwd',
	application: {name: "my app", vendor: "me", version: "current"}
)

pp mailserver.Statistics.getChartData({classname: 'Connections', name: 'SMTP', scaleId: 4})

mailserver.Session.logout

Activate fresh new instance of Operator

operator = Kerio::Api::Client.new(url: URI.parse('https://localhost:4021/admin/api/jsonrpc/'))

operator.ProductActivation.activate(
       adminPassword: "pwd",
       adminLanguage: "en",
       adminEmail: "[email protected]",
       pbxLanguageId: 2,
       pbxStartingNumber: "10",
       timeZoneId: "",
       reboot: false,
       sendClientStatistics: false,
       myKerioEnabled: false,
)

operator.Session.login(userName: 'Admin', password: 'pwd', application: {name: "my app", vendor: "me", version: "current"})
operator.Session.logout

Print Control product information

winroute = Kerio::Api::Client.new(url: URI.parse('https://localhost:4081/admin/api/jsonrpc/'))
winroute.Session.login(
	userName: 'Admin',
	password: 'pwd',
	application: {name: "", vendor: "", version: ""}
)

pp winroute.ProductInfo.get
winroute.Session.logout

Upload Operator License

license_id = operator.upload('license.txt')['fileUpload']['id']
pp operator.Server.uploadLicense(fileId: license_id)

Operator Backup

pp operator.SystemBackup.backupCancel
pp operator.SystemBackup.backupStart(
        "sections": {
                "SYSTEM_DATABASE": true,
                "VOICE_MAIL": true,
                "SYSTEM_LOG": true,
                "CALL_LOG": true,
                "LICENSE": true,
                "RECORDED_CALLS": true,
                "TFTP": true
        }
)
while true do
        break if operator.SystemBackup.get['statusBackup']['STATE']) != 1
        sleep 1
end
backup = operator.SystemBackup.backupDownload["fileDownload"]

File.open(backup["name"], "w") do |file|
        operator.download(backup["url"]) do |fragment|
                file.write(fragment)
        end
end