Developer Zone

Getting Started

Getting Started

Kerio API is built on solid foundations of JSON-RPC, whose advantages include easy of use code readability and wide support among different programming languages and publicly available libraries. If you want, you can use the PHP library, which we have prepared for you.


Kerio APIs Client Library for PHP

Kerio APIs Client Library for PHP (i.e. kerio-api-php) is designed as a layer between user applications and Kerio products. With kerio-api-php, you can easily communicate directly with your server, e.g. Kerio Connect without diving deep into the underlining JSON-RPC architecture. Encapsulation of JSON requests and response is done automatically by the library.

Kerio APIs Client Library for PHP


Environment

Application can run API on the same machine where operates Kerio Connect server or remotely on any other machine. Even your woking desktop.

To run kerio-api-php your host just needs a couple of things:

  • Apache HTTP Server 2.0 or newer
  • PHP 5.1 or newer with OpenSSL and JSON libraries

Recommended LAMP

You can download any web development environment, also known as LAMP/WAMP software bundle.

For example, we tried this:

 

Running the Kerio APIs Client Library for PHP

Manual procedure
Step 1 Download the kerio-api-php from here
Step 2 Move the package in your Apache document root, usually "/var/www/html"
Step 3 Unzip here the kerio-api-php
Step 4 Open your browser and navigate to http://your-server/kerio-api-php

If you want to just try API examples in your existing environment, you can use the VMware-ready virtual appliance.

VMware Virtual Appliance DOWNLOAD