DeltiaAide

API publique

Vue d'ensemble du module, exposer les données CRM et de facturation à des outils tiers via une API REST

À quoi ça sert

Le module « API publique » expose les données du CRM et de la Facturation à des outils extérieurs — un connecteur no-code, un tableau de bord maison, un script — par une API REST authentifiée par clé. Vous créez une clé, choisissez précisément ce qu'elle a le droit de lire ou d'écrire, et la donnez à l'outil qui doit s'en servir.

Chaque clé a ses propres droits, indépendants d'un compte utilisateur : elle ne voit que les périmètres, les rôles et les accès qui lui sont attribués à sa création. La page « API publique » est réservée aux administrateurs du module : personne d'autre ne la voit dans la page « Intégrations ». Son activation suit la même règle que les autres modules — facturée, réservée aux intervenants Deltia. Voir Activer et configurer les modules.

Concepts clés

Les pages de ce module :

Vocabulaire commun à ces pages :

  • Clé API — un identifiant secret créé pour un outil tiers, avec un nom, une durée de vie, un ou plusieurs périmètres, des rôles facultatifs et une liste d'accès. Il n'est affiché en clair qu'une seule fois, à la création.
  • Périmètres — les périmètres de l'organisation dont la clé voit les données, au même titre qu'un compte utilisateur. Voir Périmètres et rôles.
  • Rôles — les rôles de l'organisation que la clé détient. Ils ne donnent aucune donnée : ils ouvrent à la clé les entités et champs du CRM réservés à ces rôles. Seul un administrateur de l'organisation peut en attribuer.
  • Référence de l'API — la documentation technique de l'API (OpenAPI), destinée à la personne qui développe l'intégration, pas à l'utilisateur final de Deltia.

Comment faire

Ouvrir la page « API publique »

  1. Cliquez sur votre avatar, puis, dans la partie « Administration » du menu, sur « Intégrations ».
  2. Cliquez sur la carte « API publique ».
  3. La page affiche la liste des clés à gauche, et à droite le détail de la clé sélectionnée ou, par défaut, la référence de l'API.

La carte « API publique » n'apparaît que pour un administrateur du module API ; le module n'a plus d'entrée dans le menu latéral. Voir Accès aux modules.

Consulter la référence technique de l'API

  1. Sur la page « API publique », cliquez sur « Référence de l'API », en haut de la liste des clés.
  2. Téléchargez le fichier « openapi.json », ouvrez la référence en « Plein écran », ou cliquez sur « Guide » pour la documentation destinée aux développeurs.

Cette référence décrit chaque opération disponible pour les outils tiers ; elle s'adresse à qui développe l'intégration, pas à l'administrateur qui distribue les clés.

Référence

Qui peut quoi

OpérationQui
Voir la page « API publique »Un administrateur du module API
Créer, consulter, renommer, révoquer une cléUn administrateur du module API
Restreindre l'exposition de l'APIUn administrateur du module API
Modifier la limite de requêtes et la rétention du journalUn administrateur du module API
Activer le moduleUn intervenant Deltia

Questions fréquentes

Un utilisateur du module sans le rôle administrateur peut-il voir la page ?

Non. La carte « API publique » de la page « Intégrations » n'apparaît que pour un administrateur du module API ; il n'existe pas d'accès partiel pour un simple utilisateur du module.

Quelle est la différence avec le module MCP ?

Le module MCP connecte un assistant IA qui agit en votre nom, avec vos propres droits. L'API publique connecte un outil tiers muni d'une clé, avec les accès propres à cette clé — indépendants d'un compte utilisateur. Voir MCP.

Sur cette page