Autoriser d'autres logiciels à lire vos données

L'API Studio : publication d'un écran à la fois, émission d'une clé, association à une adresse, et même publication en tant que serveur MCP pour un agent d'IA.

Tôt ou tard, un service extérieur à TRANXACT aura besoin de vos données : un outil de reporting, le système d’un partenaire, un site web nécessitant la liste de prix, un agent IA interrogé sur votre activité. L’API Studio, accessible via la Plateforme, vous permet de définir les accès autorisés, écran par écran, colonne par colonne.

Rien n'est accessible de l'extérieur tant que personne ne l'a publié. Il n'existe aucun paramètre permettant d'accéder à tout, ni aucune clé donnant accès à l'ensemble des ressources. Un déploiement flambant neuf ne possède aucune interface API ; c'est la position de départ idéale, plutôt qu'un système en attente d'activation.

Les quatre décisions, dans l'ordre

Quoi	Ce que cela décide	Qui le fait habituellement
Une exposition	Cet écran pourrait bien quitter l'entreprise — quelles colonnes, quelles lignes, et si des données peuvent y être réécrites.	Quiconque possède les données
Un client	Ce logiciel existe bel et bien, il s'appelle comment, il faut contacter à son sujet et il représente quel utilisateur parmi les vôtres.	Quiconque gère l'intégration
Une subvention	Que ce client puisse atteindre cette visibilité, grâce à ces verbes.	Quiconque gère l'intégration
Une adresse autorisée	La clé peut être présentée depuis l'origine du navigateur, un hôte, une adresse serveur ou un réseau.	Quiconque gère l'intégration

La plateforme propose trois rôles distincts, volontairement séparés. Un éditeur d'API décide des données autorisées à être exportées et ne peut émettre de clé. Un registraire d'API émet des clés et ne peut créer d'exposition. Un examinateur d'API consulte toutes les données sans les modifier. Gérée par une seule personne, la publication du tableau de paie et l'émission d'une clé permettant d'y accéder constituent une procédure d'exportation complète et non supervisée, où chaque étape ressemble à une simple modification administrative.

Publication d'un écran

Ouvrez la plateforme → API Studio et sélectionnez un écran. La liste affiche tous les écrans de la console, extraits directement du produit ; par conséquent, un écran inclus dans cette version y figure.
Cochez les colonnes susceptibles d'être envoyées. Seules les données non cochées sont transmises : ni dans une liste, ni dans un enregistrement individuel, ni dans les données renvoyées par l'utilisateur. Rien n'est coché au départ, volontairement.
Choisissez les verbes. La lecture est activée par défaut ; la création, la modification et la suppression nécessitent chacune une décision distincte, car autoriser leur système à lire votre document maître et l’autoriser à le supprimer ne constituent pas la même action.
Il est possible de limiter les résultats à certaines lignes : factures émises uniquement, et uniquement pour l’année en cours. Ce filtre, identique à celui utilisé pour chaque liste, est appliqué côté serveur à chaque requête, et aucune donnée envoyée par l’utilisateur ne peut le modifier.
Gardez-le. Ce n'est qu'un brouillon, et un brouillon ne mène à rien. Donnez-lui vie quand vous le voudrez vraiment.
Avant de donner une clé à qui que ce soit, appuyez sur Aperçu. Cela vous permettra de voir exactement ce que votre partenaire recevra et le nombre de colonnes masquées.

Enregistrement du logiciel

Un client est un enregistrement d'un logiciel : son nom, sa fonction, la personne à contacter à son sujet et, surtout, l'utilisateur qui le contrôle. Chaque appel effectué par la clé est effectué au nom de cet utilisateur. Ce que cet utilisateur ne peut pas faire, la clé ne peut pas le faire non plus.

Il s'agit du champ le plus important à l'écran, et c'est pourquoi une restriction d'accès ne peut que limiter les droits et jamais les élargir. Attribuez une clé à un utilisateur créé à cet effet, disposant du rôle le plus restreint nécessaire à la tâche, et non à un véritable administrateur par commodité.

La clé n'est affichée qu'une seule fois, lors de son émission, et jamais par la suite. L'émission d'une nouvelle clé désactive immédiatement l'ancienne. Une clé peut être retirée sans supprimer le client ; le registre conserve donc la trace des personnes ayant eu accès à la clé et de la date de son retrait.

Où une clé peut être utilisée à partir de

Une clé sans adresse autorisée est inopérante. L'absence d'adresses spécifiées signifie qu'elles ne sont pas encore accessibles et ne le seront jamais, car le risque principal réside dans une clé divulguée fonctionnant depuis n'importe quel ordinateur portable au monde. Il existe quatre types d'entrée : l'origine du navigateur, l'hôte référent, une adresse unique ou un réseau au format CIDR.

Un client peut être déclaré utilisable de partout, et c'est parfois le cas : il peut s'agir d'un partenaire dont l'adresse de sortie change réellement. Ce changement est intentionnel et accompagné d'un avertissement, contrairement au comportement par défaut.

Que faut-il envoyer à la personne qui s'intègre ?

Le studio imprime les quatre adresses. L'adresse de base est /api/v1, la clé est placée dans un en-tête Authorization: Bearer, /api/v1/resources liste les ressources accessibles avec cette clé, et /api/v1/openapi.json correspond à un document OpenAPI 3.1.

Ces deux éléments sont générés à partir de la clé qui les demande. Un partenaire ne reçoit jamais un document listant quarante points de terminaison qu'il ne peut pas appeler : son document décrit précisément ce qu'il peut appeler et rien d'autre, et il ne peut pas décrire un chemin qui serait refusé, car il est construit à partir des mêmes lignes que celles vérifiées par le gestionnaire de requêtes.

Les mêmes données pour un agent d'IA

L'adresse /api/v1/mcp est un serveur du protocole MCP (Model Context Protocol). Un agent qui s'y connecte reçoit un outil pour chaque action possible associée à la clé, et rien d'autre : aucun outil pour des données non publiées, aucun outil pour un verbe non autorisé. Il s'agit de la même publication, décrite pour un modèle et non pour un développeur, ce qui garantit leur parfaite cohérence.

Saisissez les instructions MCP côté client. C'est le seul endroit où il est indiqué à un modèle que ces outils accèdent à un registre réel et non à un environnement de test, et le seul endroit où vous pouvez préciser que les commandes mentionnées ici sont des bons de commande et non des commandes de vente.

Que se passe-t-il à chaque appel ?

Un appel publié n'est pas un accès direct à la base de données. Il est authentifié, vérifié par rapport aux autorisations et aux droits d'accès, puis exécuté par votre compte utilisateur via l'API de la plateforme — la même méthode que celle utilisée par la console. La gestion du périmètre (entreprise et unité commerciale), les restrictions géographiques, les périodes de fermeture, les règles de publication, les champs personnalisés, la logique personnalisée, les possibilités de modification et l'historique d'audit sont tous concernés, car il s'agit du même code exécuté.

Chaque appel est enregistré, autorisé ou refusé, avec le motif. Ce journal se trouve dans Plateforme → API Studio → Journal des appels API, et la ligne la plus intéressante qu'il contient est celle d'une clé présentée depuis une adresse non autorisée.

Quand ça ne fonctionne pas

Ce que voit le partenaire	Ce que cela signifie
Cette clé API n'est pas reconnue.	Clé incorrecte, ou une nouvelle a été émise depuis.
Cette clé API n'a aucune adresse autorisée.	Personne n'a encore précisé où il pourrait être utilisé.
Cette clé API ne peut pas être utilisée ici.	Il indique l'origine et l'adresse de livraison réelle — généralement, le partenaire a changé de serveur.
Rien n'est publié ici sous la forme de X	Le nom est incorrect, ou cette clé n'est pas accessible, ou il s'agit encore d'une ébauche.
Cette clé ne peut pas créer de X	L'exposition ou la subvention ne permet pas ce verbe.
Vous n'êtes pas autorisé à consulter X	La subvention est valide, mais pas l'utilisateur exécutant le programme. Le studio les répertorie avant même qu'un partenaire ait à les rechercher.

La liste des clients affiche une colonne « Disponibilité » plutôt qu'un simple statut, car un client peut être actif, détenir une clé et pourtant ne rien pouvoir faire : aucun utilisateur disponible, aucune adresse autorisée, aucune requête accordée. Passer une après-midi entière à lire « Actif » alors que chaque appel est refusé, c'est comme ça.