Documentation

Introduction

Cette documentation couvre la version hébergée et l'installation sur vos serveurs. Le logiciel est identique dans les deux cas ; seules les parties sauvegarde et mise à jour changent.

Illustration de la documentation : manuel ouvert, sommaire et bloc de code

Choisir son mode

La version hébergée conviendra si vous ne voulez pas gérer PostgreSQL, Redis ni les certificats. L'auto-hébergement conviendra si vos données doivent rester sur votre infrastructure ou si vous voulez modifier le code.

  • Version hébergée : créez un espace, ajoutez vos agents, branchez votre adresse email. Comptez vingt minutes.
  • Auto-hébergement : suivez le guide d'installation. Comptez une heure sur une machine neuve.

Vocabulaire

Espace de travail
Une instance logique : vos agents, vos tickets, votre portail.
Ticket
Une demande, son fil de messages, ses notes internes et son historique.
Vue
Un filtre enregistré sur la liste des tickets, privé ou partagé.
Déclencheur
Une règle conditions-actions exécutée à un évènement donné.
Politique SLA
Un jeu de délais appliqué à un segment de tickets.

Premier appel API

Créez un jeton dans Administration puis Développeurs. Toutes les routes vivent sous/api/v1.

curl https://acme.open-helpdesk.com/api/v1/tickets?status=open \
  -H "Authorization: Bearer $OHD_TOKEN"

La référence complète est sur la page API REST.

Versions et support

Une version mineure toutes les six semaines, correctifs de sécurité sous 24 heures. Les notes de version listent les migrations de base de données à appliquer, qui s'exécutent automatiquement au démarrage du conteneur.