Documentation
API • Preuves • Fichiers OTS
← Dashboard API Guide OTS Docs Architecture

Accès rapide

Preuve publique (JSON)

Retourne la preuve OpenTimestamps + métadonnées pour un lot.

GET /api/v1/public/proof/<lotId>

Télécharger un fichier OTS

Les fichiers sont des batches (ex: batch_1700000000000.txt.ots).

GET /files/ots/<filename>

Ouvrir un document (PDF)

Documents internes (PDF/images) s’ils sont présents sur le serveur.

GET /files/docs/<filename>

API

Base URL : /api
Les endpoints admin nécessitent un JWT (connexion sur le dashboard).
Type Endpoint Description
PUBLIC GET /api/v1/public/proof/<lotId> Preuve publique (OpenTimestamps + liens fichiers).
PUBLIC GET /health Healthcheck simple.
ADMIN POST /api/v1/auth/login Connexion admin (retourne un JWT).
ADMIN GET /api/v1/admin/dashboard/stats Compteurs (lots, events, OTS...).
ADMIN GET /api/v1/admin/dashboard/lots Lots récents + filtres (q/status/from/to/take).
ADMIN GET /api/v1/admin/dashboard/events Événements récents (lotId/take).
ADMIN GET /api/v1/admin/dashboard/lot/<lotId> Détail lot + 50 events.
ADMIN GET /api/v1/admin/dashboard/ots-requests Historique des runs OTS.
ADMIN POST /api/v1/admin/ots/run Déclencher un batch d’ancrage OTS.
ADMIN POST /api/v1/admin/ots/status Voir l’état des derniers runs.

Guide utilisateur

Créer un lot

  1. Connectez‑vous (bouton Connexion sur le dashboard).
  2. Dans Lots récents, cliquez sur Créer un lot (ou utilisez l’API via /api/v1/lots).
  3. Vérifiez que le lot apparaît et que son statut est CREATED.

Ajouter un événement

  1. Ouvrez le détail du lot (clic sur son ID).
  2. Ajoutez un événement (ex: LANDED, SHIPPED…)
  3. Chaque événement génère un hash qui alimente la chaîne de traçabilité.

Vérification blockchain (OpenTimestamps / Bitcoin)

Le bloc Preuve Blockchain Bitcoin affiche le statut OpenTimestamps des événements. Une preuve passe typiquement par : PENDING → ANCHORED → CONFIRMED.

  • PENDING : hash enregistré, en attente de batch d’ancrage.
  • ANCHORED : un fichier .ots existe (timestamp créé), la confirmation Bitcoin peut prendre du temps.
  • CONFIRMED : ancrage confirmé, détails de bloc disponibles (si fournis par la vérification).
  • FAILED : échec technique (voir l’historique + relancer un run OTS).
Conseil : si un lot reste en PENDING, lancez un run OTS : POST /api/v1/admin/ots/run.
Ensuite, rechargez le lot. Le badge devrait passer à ANCHORED dès que le fichier .ots est créé.

Les boutons Télécharger .ots et Télécharger fichier d’origine permettent de récupérer les preuves. Vous pouvez ensuite faire une vérification externe avec ots verify.

Page Architecture

Une page dédiée explique les composants (admin-ui, API, worker OTS, Nginx, DB) et les flux.

Ouvrir Architecture

Fichiers OTS

Les preuves OpenTimestamps sont écrites dans /files/ots/. Les fichiers générés sont des batches (ex: batch_...txt.ots).

Astuce : le nom exact du fichier est stocké côté DB (champ otsFileKey / otsHashesKey).
Exemple : ots/batch_1700000000000.txt.ots → accessible via /files/ots/batch_1700000000000.txt.ots

Docs (PDF / Images)

Les documents internes sont servis depuis /files/docs/. L’index de répertoire est désactivé (sécurité), il faut donc connaître le nom du fichier.