Web Analytics Made Easy - Statcounter
Skip to content

Référence API

Documentation complète de l'API du backend Duckling.

URL de base

http://localhost:5001/api

Authentification

Actuellement, l'API ne nécessite pas d'authentification. Pour les déploiements en production, envisagez d'ajouter un middleware d'authentification.

Sections

Référence rapide

Endpoints de conversion

Endpoint Méthode Description
/convert POST Téléverser et convertir un document
/convert/batch POST Convertir plusieurs documents en lot
/convert/{job_id}/status GET Obtenir le statut de conversion
/convert/{job_id}/result GET Obtenir le résultat de conversion
/convert/{job_id}/images GET Lister les images extraites
/convert/{job_id}/images/{id} GET Télécharger une image extraite
/convert/{job_id}/tables GET Lister les tableaux extraits
/convert/{job_id}/tables/{id}/csv GET Télécharger un tableau en CSV
/convert/{job_id}/chunks GET Obtenir les segments du document
/export/{job_id}/{format} GET Télécharger le fichier converti

Endpoints des paramètres

Endpoint Méthode Description
/settings GET/PUT Obtenir/mettre à jour tous les paramètres
/settings/reset POST Réinitialiser aux valeurs par défaut
/settings/formats GET Lister les formats pris en charge
/settings/ocr GET/PUT Paramètres OCR
/settings/tables GET/PUT Paramètres des tableaux
/settings/images GET/PUT Paramètres des images
/settings/performance GET/PUT Paramètres de performance
/settings/chunking GET/PUT Paramètres de segmentation

Endpoints de l'historique

Endpoint Méthode Description
/history GET Lister l'historique des conversions
/history/{job_id} GET Obtenir une entrée d'historique
/history/stats GET Obtenir les statistiques de conversion
/history/search GET Rechercher dans l'historique

Vérification de santé

GET /health

Réponse

{
  "status": "healthy",
  "service": "duckling-backend"
}

Réponses d'erreur

Tous les endpoints peuvent renvoyer des réponses d'erreur au format suivant :

{
  "error": "Type d'erreur",
  "message": "Message d'erreur détaillé"
}

Codes de statut HTTP

Code Description
200 Succès
202 Accepté (opération asynchrone démarrée)
400 Requête invalide (entrée invalide)
404 Non trouvé
413 Charge utile trop volumineuse
500 Erreur interne du serveur

Limitation du débit

Actuellement, aucune limitation du débit n'est implémentée. Pour les déploiements en production, envisagez d'ajouter un middleware de limitation du débit.

CORS

L'API autorise les requêtes cross-origin depuis l'origine du frontend configurée (par défaut : http://localhost:3000).