Documentation API
L’API publique donne accès aux formats de dossiers, aux règles de vérification et à la méthode de BLACKPROOF. Un script peut ainsi connaître la structure d’un export ou les contrôles attendus, sans transmettre de document au site.
Elle est publique, statique et en lecture seule, sans compte ni clé API.
Son adresse de base est https://blackproof.fr. La version actuelle est
blackproof-public-api-v0.1.0-alpha.
Faire une première requête
Depuis un terminal, lire le catalogue des ressources disponibles :
curl --fail --silent --show-error https://blackproof.fr/api/index.json
Puis lire la version publiée et les limites du produit :
curl --fail --silent --show-error https://blackproof.fr/api/status.json
Ces requêtes utilisent GET, sans corps de requête ni authentification.
Les réponses sont des fichiers JSON. Le catalogue contient notamment endpoints,
humanPages et publicArtifacts : les routes, les pages de documentation et les
exemples fictifs disponibles. Il constitue la liste complète des ressources.
Les contrats de l’API indiquent leur apiVersion et leur resource. Les schémas
JSON possèdent leur propre format et leur propre version : ne pas leur imposer
la structure d’une réponse du catalogue.
Choisir la bonne ressource
| Besoin | Ressource publique |
|---|---|
| Découvrir toutes les routes | Catalogue API |
| Connaître la version publiée et les limites | Statut public |
| Comprendre la méthode et les contrôles | Méthodologie |
| Connaître les catégories de justificatifs attendus | Bibliothèque de preuves |
| Lire les référentiels et leurs exigences | Référentiels |
| Comprendre l’indicateur de préparation | ProofDebt |
| Connaître les formats et limites de l’import local | Contrat d’import |
| Connaître les contrôles d’un dossier | Contrat de vérification |
Le contrat de vérification décrit les contrôles. Il ne vérifie pas un fichier sur le serveur. Pour examiner un export, utiliser le vérificateur dans le navigateur ou le serveur MCP local.
Choisir le schéma correspondant à son export
Le dossier maître conserve les informations de travail. La version client, appelée Delivery, contient les informations sélectionnées pour transmission. Leurs schémas ne sont pas interchangeables.
- Dossier maître : point de découverte, V1 historique, V2 historique et V3 courante.
- Version client : Delivery V4 historique et Delivery V5 courante.
- Import XLSX : schéma de provenance de l’import.
- Suivi d’une version client : rapport de changements, signature et déclaration de révocation.
- Contrôle des empreintes : exemples de calcul de référence.
Les adresses versionnées des schémas sont immuables. Utiliser celle qui correspond au format du fichier reçu et vérifier les erreurs de lecture avant de conclure. Le contrat API reste en alpha ; une intégration doit vérifier la version annoncée. Le schéma historique de statut reste publié pour compatibilité, mais le registre public a été retiré : aucun statut courant de dossier n’est disponible en ligne.
Essayer avec des données fictives
- Exemple de dossier expliqué
- Export client JSON
- Archive client ZIP
- Questionnaire Excel
- Questionnaire CSV UTF-8
Ces fichiers sont publics et fictifs. Ils permettent d’essayer les formats sans utiliser les dossiers de votre organisation.
Données et limites
L’API ne reçoit ni questionnaire, ni justificatif, ni dossier privé. Elle ne propose aucune route d’envoi de documents, de création de dossier ou d’exécution distante d’un audit. Les ressources publiques peuvent être mises en cache ; les dossiers restent traités sur l’appareil de leur utilisateur.
Une structure valide et une empreinte correcte ne prouvent ni la véracité des réponses, ni l’identité de l’émetteur, ni la conformité. Une relecture humaine reste nécessaire avant toute transmission.
Le MCP est une intégration distincte, exécutée sur votre poste. Sa documentation dédiée décrit l’installation, les outils et les conditions de confidentialité.