Connect. Communicate. Collaborate. Securely.

Home » Developer Zone » API/SDK Writers » Documentation for API for Control/Operator
  •  
nhoague

Messages: 853
Karma: 18
Send a private message to this user
Is there any documentation for API for Control and Operator?
  •  
Miroslav Osladil (Kerio)

Messages: 188

Karma: 27
Send a private message to this user
Hi Nicholas,

unfortunately there is yet no oficial documentation we can share with you at the moment. Maybe if you ask for "How to do this..." I can help you.

Looking forward!

M.

Miroslav Osladil
Senior Developer
Kerio Technologies

The views I express are my own and do not necessarily reflect the views of Kerio Technologies.
  •  
nhoague

Messages: 853
Karma: 18
Send a private message to this user
Ok, cool. Thanks.

So, how do I get the registration info for Control via API? Operator, Connect and Workspace all use ProductRegistration.getFullStatus, but this doesnt work in Control.

Thanks!
  •  
Miroslav Osladil (Kerio)

Messages: 188

Karma: 27
Send a private message to this user
What version of Kerio Control do you have? I tested it in versions 7.4.2 and 8.0.0 and it works well.

Request:
{"jsonrpc":"2.0","id":2,"method":"ProductRegistration.getFullStatus"}

Response:
{
  "jsonrpc": "2.0",
  "id": 2,
  "result": {
    "status": {
      "regType": "rsProductRegistered",
      "Id": "XYZ-123",
      "company": "Kerio Technologies s.r.o",
      "users": 300,
      "expirations": [
        {
          "type": "License",
          "isUnlimited": false,
          "remainingDays": 168,
          "date": 1374015599
        },
        {
          "type": "Subscription",
          "isUnlimited": false,
          "remainingDays": 168,
          "date": 1374015599
        }
      ]
    }
  }
}


M.

Miroslav Osladil
Senior Developer
Kerio Technologies

The views I express are my own and do not necessarily reflect the views of Kerio Technologies.
  •  
nhoague

Messages: 853
Karma: 18
Send a private message to this user
Now why didnt it work when I tried?! Thank you!

  •  
nhoague

Messages: 853
Karma: 18
Send a private message to this user
Ok last question for the day ...

In Connect the method AdvancedOptions.checkUpdates exists but not in Control, Operator or Workspace. Can I (and if so) how do I check for updates in these products?

Thanks!
  •  
Miroslav Osladil (Kerio)

Messages: 188

Karma: 27
Send a private message to this user
You are right. Kerio Connect is not perfect in this case, it uses "own" implementation of update checker (AdvancedOptions. checkUpdates).

We will try to unify it in some next release. The other products use an interface UpdateChecker. It has methods like:

  • get
  • set
  • check
  • etc.

Please, use attached IDL documentation for your reference of the methods and data structures.

A sample request for Kerio Operator is as follows.

Request:
{"jsonrpc":"2.0","id":1,"method":"UpdateChecker.check","params":{}}

Response:
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "result": [
      
    ],
    "info": {
      "ok": true,
      "newVersion": true,
      "lastCheckTime": 1359621004,
      "packageCode": "KTS:010.002.00000.B.000.000",
      "description": "Kerio Operator test",
      "downloadURL": "http:\/\/localhost/kerio-operator-upgrade-6.6.6-666-b6.img",
      "infoURL": "http:\/\/www.kerio.com\/"
    }
  }
}


M.


Miroslav Osladil
Senior Developer
Kerio Technologies

The views I express are my own and do not necessarily reflect the views of Kerio Technologies.
  •  
nhoague

Messages: 853
Karma: 18
Send a private message to this user
Thanks, working on it now.

Is there a way to build a backup process for Control and Operator via API?
  •  
Miroslav Osladil (Kerio)

Messages: 188

Karma: 27
Send a private message to this user
For Kerio Operator, there already is a sample application called Backup Operator in the sample_applications folder.

[Updated on: Thu, 31 January 2013 17:59]


Miroslav Osladil
Senior Developer
Kerio Technologies

The views I express are my own and do not necessarily reflect the views of Kerio Technologies.
  •  
nhoague

Messages: 853
Karma: 18
Send a private message to this user
Doh. I'll go check that out ... and Control?
  •  
nhoague

Messages: 853
Karma: 18
Send a private message to this user
Almost done! I am modifying the myServers script so I can have a list of all our devices, IP,s licenses, updates, etc. It is so cool! It will also notify me within a month of a license expiring all via cron.

I have one problem though. The login.php script calls /admin/dologin.php and it seems this only exists in Operator. Can you tell me the right path to POST form data to for connect and control?

Thanks!
  •  
Miroslav Osladil (Kerio)

Messages: 188

Karma: 27
Send a private message to this user
There are some improvements in the myServers. Let me send it, today.

Miroslav Osladil
Senior Developer
Kerio Technologies

The views I express are my own and do not necessarily reflect the views of Kerio Technologies.
  •  
Miroslav Osladil (Kerio)

Messages: 188

Karma: 27
Send a private message to this user
Here it goes. Attaching the updated login.php from upcoming MyServers - kerio-api-php 1.3.0.

M.

  • Attachment: login.php
    (Size: 2.05KB, Downloaded 49 times)

Miroslav Osladil
Senior Developer
Kerio Technologies

The views I express are my own and do not necessarily reflect the views of Kerio Technologies.
  •  
Miroslav Osladil (Kerio)

Messages: 188

Karma: 27
Send a private message to this user
nhoague wrote on Fri, 01 February 2013 02:16
Almost done! I am modifying the myServers script so I can have a list of all our devices, IP,s licenses, updates, etc. It is so cool! It will also notify me within a month of a license expiring all via cron.


You have no idea how your praise is important to us, especially in these days. Smile

Could you share a picture of your application, it would be very inspiring.

Thanks!

Miroslav Osladil
Senior Developer
Kerio Technologies

The views I express are my own and do not necessarily reflect the views of Kerio Technologies.
nhoague

Messages: 853
Karma: 18
Send a private message to this user
Hey man,

Check it out! Next I am going to add function to we can see how many licenses are in use, so we know when customer is approaching limits of license.

I bet these past few days have been hectic, just so you know I respect the developers tremendously. You guys are what directly turn our ideas into reality. And Samepage, well I like it too!

mosladil's note: attachment removed due to license numbers in the list. you never know... Smile

[Updated on: Fri, 01 February 2013 15:06] by Moderator

Previous Topic: Connect: How to get active user info
Next Topic: Changes in API
Goto Forum:
  


Disclaimer:
Kerio discussion forums are intended for open communication between forum members and may contain information and material posted by members which may be useful in learning about Kerio products. The discussion forums are not intended to provide technical support for any specific product. Any information implied or expressed in the discussion forums is that of the posting member. Kerio is in no way responsible for the information posted in the forums, or its accuracy. Kerio employees may participate in the discussions, but their postings do not represent an offical position of the company on any issues raised or discussed. Kerio reserves the right to monitor and maintain the forums to promote free and accurate exchange of information.

Current Time: Thu Aug 24 05:18:46 CEST 2017

Total time taken to generate the page: 0.00590 seconds
.:: Contact :: Home ::.
Powered by: FUDforum 3.0.4.