Anonymise — Export de la synthèse

v1.0.0 · OpenAPI

Web service REST qui renvoie la synthèse d'anonymisation au format CSV.

C'est exactement le fichier produit par le bouton « Exporter la synthèse » de l'application : le calcul des libellés de méthode et des résumés de paramètres vient d'un package partagé entre la SPA et ce service, les deux fichiers ne peuvent donc pas diverger.

Usage prévu : appeler l'endpoint au démarrage d'une anonymisation, pour archiver les règles telles qu'elles étaient à cet instant. Le service relit les règles à chaque appel, sans cache.

Le token ne donne accès qu'à la lecture : il ne permet ni de modifier une règle, ni de déclencher une anonymisation.

Serveur

https://api.anonymise.beta.ordesoft.com — Bêta

Authentification

bearerAuth — bearer

Token statique, transmis hors bande. À placer dans l'en-tête Authorization, jamais en query string — il finirait dans les journaux du proxy.

Endpoints

GET /export/synthese.csv Bearer

Synthèse d'anonymisation au format CSV

Renvoie une ligne par champ configuré — c'est-à-dire ayant une règle enregistrée en base, ou des paramètres saisis.

Le fichier est un CSV UTF-8 avec BOM, séparateur ;, ce qui permet à Excel FR de l'ouvrir sans manipulation. Les colonnes sont Table, Champ, Type, Clé, Anonymiser, Méthode, Option, Paramètres.

L'en-tête Content-Disposition porte un nom de fichier horodaté à la minute : l'enregistrer sous ce nom suffit à constituer l'archive.

Les règles visant un champ absent de la structure de la base sont ignorées, comme dans l'application.

Paramètres

NomDansRequisDescription
table query non

Restreint l'export à une table. Nom exact, sensible à la casse, tel qu'il apparaît dans la colonne « Table » de l'export complet. Omis, toutes les tables sont exportées.

Exemple : STAGIAIRE

Réponses

200

La synthèse.

Content-Disposition

Nom de fichier horodaté, ex. attachment; filename="anonymisation_hfsql_20260806-0818.csv". Le segment central vaut hfsql pour un export complet, sinon le nom de la table.

text/csv

"Table";"Champ";"Type";"Clé";"Anonymiser";"Méthode";"Option";"Paramètres"
"AVENANT";"CertificateurEmail";"Chaîne";"NON";"OUI";"Vidage";"";""
"STAGIAIRE";"Nom";"Chaîne";"NON";"OUI";"Aléatoire";"Référentiel";"Table : REF_NOMS · Champ : NOM"
"STAGIAIRE";"Email";"Chaîne";"NON";"OUI";"Valeur fixe";"";"anonyme@example.com"
401

En-tête Authorization absent, ou token invalide.

text/plain

Unauthorized
404

La table demandée n'existe pas dans la structure. Le service répond une erreur plutôt qu'un CSV réduit à sa ligne d'en-tête, pour qu'un export vide ne passe pas pour une absence de configuration.

text/plain

Table inconnue : NEXISTEPAS
502

La base de règles est momentanément injoignable. L'appel est rejouable tel quel.

text/plain

Upstream error

GET /export/openapi.json public

Ce document

Renvoie la spécification OpenAPI du service. Accessible sans authentification, pour qu'un portail d'API puisse l'aspirer.

Réponses

200

La spécification.

application/json

GET /export/docs public

Documentation lisible

Page HTML générée par le service à partir de cette même spécification. Répond aussi sur /, ce qui permet à un sous-domaine dédié de pointer sur le service sans réécriture de chemin.

Réponses

200

La page de documentation.

text/html