Aller au contenu

Développer avec KiwiDesk

Cette partie s’adresse aux intégrateurs, aux développeurs d’un outil maison et aux auteurs de plugins. KiwiDesk offre trois portes d’entrée, de la plus simple à la plus intégrée :

  • l’API REST : votre programme lit et modifie les données de KiwiDesk (tickets, clients, factures, stock…) avec une clé API ;
  • les webhooks : KiwiDesk prévient votre serveur dès que quelque chose se passe (ticket créé, statut changé, facture émise…), par une requête HTTP signée ;
  • les plugins : un paquet .zip installé par un super administrateur ajoute des onglets, des boutons, des pages et des widgets dans l’interface de KiwiDesk, et peut avoir son propre serveur.

API REST

Authentification par clé API, conventions (erreurs, pagination, montants en centimes) et recettes pas à pas en curl et en Node.js.

Découvrir l’API

Webhooks

Le catalogue des événements, la vérification de la signature HMAC-SHA256 en Node, Python et PHP, les nouvelles tentatives et le journal des envois.

Recevoir les webhooks

Plugins

Le manifeste, les emplacements, le SDK, les permissions, le stockage, le serveur du plugin, et un tutoriel complet.

Écrire un plugin

Vous voulez… Utilisez
Exporter chaque nuit les factures vers un outil comptable L’API avec une clé de boutique
Prévenir un autre logiciel quand un appareil est prêt Un webhook sur repair.ticket.status_changed
Afficher une information d’un service externe sur la fiche ticket Un plugin avec un onglet
Réagir à un événement et écrire en retour dans KiwiDesk, sans écran Un webhook et une clé API, ou un plugin avec un serveur
Donner à vos équipes un bouton qui appelle un service tiers Un plugin avec une action de fiche

Le dossier examples/ du dépôt contient des exemples complets et testés : un client de l’API en TypeScript, deux récepteurs de webhooks (Node.js et Python) et trois plugins. Ils sont décrits dans Exemples.