Inspecting Kerio API communication in a web browser
You can use a web browser to inspect the API communication used in all Kerio products. This is helpful in case you want to learn how to adapt functionality into your custom application. Refer to the API reference for complete documentation.
Enabling developer views in your browser
In order to inspect the API communication, you must enable the developer view in your browser. Refer to the list below for instructions for common browsers.
Inspecting the communication
The web administration of Kerio products uses XMLHttpRequest (XHR) to exchange JSON formatted data with your Kerio server. Browsers display this type of activity in the network details of the inspection. You can view each JSON formatted request and the corresponding response of any administrative task.
- Log in to your Kerio product's web administration
- Enable the developer view in your browser
- Perform the administrative task you want to build into your application
- Locate the JSON requests and responses in your browser's developer view
Using Google Chrome to obtain the API request for adding a user in Kerio Operator
- In Google Chrome, toggle the developer view from the menu in View > Developer > Developer Tools
- Log in to the Kerio Operator administration and create a new user. See Creating user accounts for details
- In the Google Chrome developer view, locate the Network panel. See Network panel overview for details
- Locate the resources named "jsonrpc/" in the Requests Table and select the first item
NOTE
You can filter the table results to display only API resources. In the filter box, type the string "jsonrpc".
- In the preview area of the resource, select the Headers tab
- Expand Request Payload to view the formatted JSON request
- Browse each JSON resource and examine the payload details until you locate the resource that corresponds to your action
- Click view source to show the unformatted JSON string