Comptes de services & Webhooks

Créer un compte de service, générer une clé API et configurer un webhook.

Neil la chouette

Comment faire dans Neil

Droits nécessaires
  • Le rôle Administrateur — pour créer, modifier et consulter les comptes de service

Il n'existe pas de droit plus fin : toutes les opérations sur les comptes de service exigent ce rôle.

Ajouter un Compte de Service

Configuration›Comptes de Service›Ajouter un compte de service
  1. 1
    Accédez à Configuration › Comptes de Service.
  2. 2
    Cliquez sur Ajouter un compte de service.
  3. 3
    Renseignez le nom du compte — utilisez un nom explicite identifiant le système externe (ex : « Banque A Compta »). Une adresse e-mail peut être ajoutée : elle est facultative et sert d'identifiant stable au compte pour les échanges entre serveurs.Convention : un compte par système externe. Ne jamais partager un compte entre plusieurs outils.
  4. 4
    Validez. Le compte est créé mais pas encore exploitable — il faut ajouter une clé API (bloc suivant).

Ajouter une Clé API

Configuration›Comptes de Service›[Compte]›Clés API›Ajouter une clé API
  1. 1
    Ouvrez le compte de service créé précédemment.
  2. 2
    Dans l’onglet Clés API, cliquez sur Ajouter une clé API.
  3. 3
    Renseignez la Date de fin de validité : une échéance à trois mois est proposée par défaut. Pour une clé sans échéance, cochez Illimitée.Bonne pratique : aligner l’expiration sur l’année scolaire (ex : 1er septembre) pour forcer un renouvellement annuel.
  4. 4
    Validez. La clé est affichée une seule fois. Copiez-la immédiatement et transmettez-la à l’équipe technique du système externe.⚠ Attention — Si la clé est perdue, il faudra en générer une nouvelle. L’ancienne ne peut pas être réaffichée.
  5. 5
    Le système externe utilisera cette clé dans le header HTTP X-Lucius-Api-Key pour s’authentifier auprès de l’API Neil.

Configurer le scope et les permissions

Configuration›Comptes de Service›[Compte]›Droits d’accès
  1. 1
    Ouvrez la section Droits d’accès de la fiche du compte de service.
  2. 2
    Définissez le Scope : écoles, niveaux, années scolaires, matières auxquels le compte a accès.Principe du moindre privilège : ne donner accès qu’aux données strictement nécessaires.
  3. 3
    Configurez les Permissions : sélectionnez dans l’arbre de droits uniquement les actions nécessaires (ex : lecture factures, lecture inscriptions).L’arbre est identique à celui des rôles utilisateurs (Rôles & droits d'accès). Un compte de service se configure exactement comme un profil humain.
  4. 4
    Dans la même section, définissez si besoin une période d’autorisation (date de début / fin) pour limiter l’accès dans le temps.
  5. 5
    Validez. Le compte est maintenant opérationnel avec un périmètre contrôlé.

Ajouter un Webhook

Configuration›Webhooks›Ajouter un webhook
  1. 1
    Accédez à Configuration › Webhooks.
  2. 2
    Cliquez sur Ajouter un webhook.
  3. 3
    Renseignez le nom (ex : « Inscription → Banque A ») et une description.
  4. 4
    Saisissez l’URL de destination fournie par le système externe (endpoint qui recevra les notifications).
  5. 5
    Sélectionnez la méthode HTTP (POST dans la majorité des cas).
  6. 6
    Ajoutez des headers HTTP si requis par le système destinataire (ex : clé d’authentification, Content-Type).Les headers permettent au système externe de vérifier que la requête vient bien de Neil.
  7. 7
    Validez. Le webhook est créé mais aucun événement n’est encore sélectionné — il ne notifiera rien tant que vous n’en aurez pas choisi (bloc suivant).

Sélectionner les événements d’un Webhook

Configuration›Webhooks›[Webhook]›Événements
  1. 1
    Ouvrez le webhook créé précédemment.
  2. 2
    Accédez à l’onglet Événements.
  3. 3
    Parcourez les 413 événements regroupés par domaine (Configuration, Pédagogie, Scolarité, Marketing, RH, Comptabilité).
  4. 4
    Cochez uniquement les événements pertinents pour le système destinataire.Ex. pour Banque A : secretariat.registrations.register_formula (nouvelle inscription) et accounting.invoices.create (nouvelle facture).
  5. 5
    Validez. Le webhook commencera à envoyer des notifications en temps réel dès qu’un événement coché se produira.⚠ Vérification — Après la première notification, consultez les événements du webhook pour vérifier que le système externe répond correctement.

Activer / Désactiver un Compte ou un Webhook

Configuration›[Comptes de Service | Webhooks]›Activer / Désactiver
  1. 1
    Ouvrez le compte de service ou le webhook concerné.
  2. 2
    Utilisez l’action Activer ou Désactiver.Désactiver un compte de service coupe immédiatement l’accès API du système externe — sans supprimer la configuration.
  3. 3
    Pour les clés API individuelles, la même logique s’applique : vous pouvez désactiver une clé sans supprimer le compte.Utile lors d’un renouvellement de clé : créez la nouvelle, transmettez-la, puis désactivez l’ancienne.
Neil

Logiciel de pilotage intelligent dédié à l'enseignement supérieur.