Demander une API à l'éditeur de votre logiciel métier : la méthode par cas d'usage

« Connecter nos logiciels entre eux, on ne savait même pas que c'était quelque chose qu'on pouvait demander. »

« Quand on demande l'accès à nos propres données, l'éditeur nous demande d'abord de justifier pourquoi. »

« On nous promet depuis longtemps une publication automatique. »

Une API, sans jargon

Une API est un point d'accès que l'éditeur ouvre à d'autres logiciels. Au lieu qu'un agent recopie une information, un programme la lit ou l'envoie directement, selon des règles fixées par l'éditeur.

Vous n'avez pas besoin de savoir programmer pour l'exiger. Il suffit de décrire ce que vous voulez faire avec vos données.

Pourquoi « avez-vous une API ? » ne suffit pas

Une demande trop générale appelle une réponse générale, voire une question en retour. L'éditeur ne sait ni quelles données ouvrir, ni dans quel sens, ni à quelle fréquence.

Une demande par cas d'usage lui donne de quoi répondre précisément. Elle permet aussi de comparer les réponses de plusieurs éditeurs sur une base commune.

Voici des cas d'usage que l'on rencontre souvent.

• Déposer un document dans le circuit de signature depuis l'outil où il a été rédigé.
• Être prévenu automatiquement quand un document est signé.
• Extraire chaque mois l'exécuté budgétaire vers un tableau de suivi.
• Publier sur le site les documents adoptés sans les ressaisir.

Un modèle de demande à adapter

Ce modèle tient en une page. Remplacez les crochets, gardez un cas d'usage par paragraphe et classez-les par priorité.

Objet : accès programmatique à nos données dans [nom du logiciel]

Madame, Monsieur,

Nous souhaitons automatiser plusieurs échanges entre [nom du logiciel] et nos autres outils. Voici nos cas d'usage, par ordre de priorité.

Cas d'usage 1 : [action, par exemple déposer un document en signature].
Données concernées : [liste des champs].
Sens de l'échange : [lecture, écriture ou les deux].
Fréquence : [par jour, par semaine, à chaque événement].
Déclencheur : [événement ou horaire].

Cas d'usage 2 : [même structure].

Pour chacun de ces cas, pourriez-vous nous indiquer :
- s'il existe une API documentée qui le permet, et où trouver sa documentation ;
- le mode d'authentification et les droits nécessaires ;
- les éventuels coûts d'activation ou d'abonnement ;
- le délai de mise à disposition si la fonction n'existe pas encore ;
- la possibilité d'exporter l'ensemble de nos données dans un format ouvert.

Nous restons disponibles pour en échanger.

Bien cordialement,

Envoyez la demande par écrit et conservez la réponse. Elle servira de base au moment de renouveler le contrat.

L'inscrire dans vos marchés publics

Le meilleur moment pour obtenir une API est celui où l'éditeur cherche à remporter le marché. Au renouvellement, les besoins d'accès aux données peuvent figurer dans le cahier des charges, au même titre que les fonctions métier.

Concrètement, l'acheteur peut demander une API documentée qui couvre les cas d'usage listés, l'export complet des données dans un format ouvert et des notifications sur les événements utiles, comme une signature. Ces exigences se décrivent par la fonction attendue, sans désigner de produit.

Lorsque le marché s'y réfère, le CCAG-TIC de 2021 consacre son article 42 à la réversibilité et à la transférabilité, c'est-à-dire aux conditions de reprise des données et du service en fin de contrat. Votre service de la commande publique pourra vous aider à l'articuler avec vos clauses particulières.

Une fois l'accès ouvert

Une API ouverte ne fait rien seule. Il faut encore un outil qui orchestre les échanges entre vos logiciels, idéalement hébergé chez vous ou en France.

C'est le rôle d'un orchestrateur comme n8n, que nous présentons dans l'article n8n auto-hébergé : automatiser sans que vos données quittent la France. Pour choisir les échanges à automatiser d'abord, commencez par chiffrer le temps récupérable.

Pour une collectivité, cette démarche fait partie de notre audit IA et organisation, qui repère les logiciels à relier et les données à demander.