GFI KerioConnect® – Espace développeurs

Une partie de notre mission consiste à mettre en place une plateforme ouverte de communication et de collaboration, permettant aux administrateurs et aux développeurs d'accéder facilement au produit et de l'intégrer à des solutions tierces. L'API d'administration de GFI KerioConnect permet aux administrateurs de faciliter leur travail quotidien et d'automatiser de nombreuses procédures. Grâce à cette API, vous pouvez créer des scripts puissants pour vous aider dans vos tâches quotidiennes courantes.

Caractéristiques et avantages

• Interface JSON-RPC simple pouvant être utilisée depuis n'importe quel client HTTP

• Architecture API cohérente

• De nombreuses possibilités et utilisations

Cas d'utilisation

• Configuration du serveur : utilisateurs, domaines, filtre de contenu et plus encore

• Surveillance de base

• Statistiques de fréquentation

• Automatisation des tâches

Documentation

Les caractéristiques techniques sont disponibles dans la section « Documentation de référence du produit » ci-dessous.

Pour commencer

L'API Kerio repose sur JSON-RPC, dont les avantages comprennent la facilité d'utilisation, la lisibilité du code et une large prise en charge par différents langages de programmation et bibliothèques accessibles au public. Vous pouvez utiliser la bibliothèque PHP que nous avons mise à votre disposition.

Bibliothèque client des API Kerio pour PHP

La bibliothèque client Kerio APIs pour PHP (c'est-à-dire kerio-api-php) est conçue pour servir d'interface entre les applications utilisateur et les produits Kerio. Grâce à kerio-api-php, vous pouvez facilement communiquer directement avec votre serveur, par exemple GFI KerioConnect, sans avoir à vous plonger dans les détails de l'architecture JSON-RPC sous-jacente. L'encapsulation des requêtes et des réponses JSON est effectuée automatiquement par la bibliothèque.

Environnement

L'application peut exécuter l'API sur la même machine que celle qui héberge le serveur GFI KerioConnect, ou à distance sur n'importe quelle autre machine. Pour exécuter kerio-api-php, votre hôte doit disposer des éléments suivants :

• Serveur HTTP Apache 2.0 ou version ultérieure

• PHP 5.1 ou version ultérieure avec les bibliothèques OpenSSL et JSON

LAMP recommandé

Vous pouvez télécharger n'importe quel environnement de développement web, également appelé « suite logicielle LAMP/WAMP », comme dans les exemples ci-dessous :

• www.mamp.info (Mac OS X)

• www.easyphp.org (Windows)

• www.wampserver.com (Windows)

Utilisation de la bibliothèque cliente des API Kerio pour PHP

Procédure manuelle

Étape 1 – Téléchargez le fichier « kerio-api-php »
Étape 2 – Déplacez le paquet vers le répertoire racine des documents d'Apache, généralement « /var/www/html »
Étape 3 – Décompressez ici le fichier « kerio-api-php »
Étape 4 – Ouvrez votre navigateur et rendez-vous à l'adresse https://your-server/kerio-api-php

Pour tester les exemples d'API dans votre environnement actuel, utilisez l'appareil virtuel compatible VMware.

Téléchargements et documentation

Remarque : en téléchargeant les API et l'appareil virtuel VMware ci-dessous, vous acceptez les conditions du contrat de licence d'utilisateur final du SDK Kerio.

Contrat de licence

Spécification JSON-RPC 2.0

Documentation

L'API Kerio repose sur les bases solides du protocole JSON-RPC, dont les avantages comprennent la facilité d'utilisation, la lisibilité du code et une large prise en charge par différents langages de programmation et bibliothèques accessibles au public. Pour consulter l'intégralité des spécifications JSON-RPC 2.0, cliquez ici.

GFI KerioConnect

Notre interface d'administration Web pour GFI KerioConnect utilise la même API que celle qui est désormais à votre disposition. Grâce à la nouvelle API d'administration pour GFI KerioConnect, vous pouvez accéder à votre serveur GFI KerioConnect, l'intégrer à des solutions tierces ou écrire des scripts simples pour effectuer des tâches d'administration avancées. Actuellement, seule l'API d'administration pour GFI KerioConnect est disponible. Les autres API permettant de gérer les calendriers ou les données utilisateur ne sont pas prises en charge. Vous pouvez utiliser à la place les protocoles IMAP/CalDAV/CardDAV.

L'API est conçue pour être accessible depuis n'importe quel langage de programmation. Connectez-vous via HTTPS, envoyez une requête dans un format courant et lisible par l'utilisateur (JSON) et recevez une réponse dans le même format.

Bibliothèques de programmation

Vous pouvez également utiliser la bibliothèque client des API Kerio pour PHP afin de faciliter l'intégration dans vos scripts et vos applications.