Référence des endpoints API

Cette page documente en détail tous les endpoints disponibles dans l'API ParseMyFile.

Base URL

Tous les endpoints sont accessibles via l'URL de base :

https://api.parsemyfile.com

Authentification

Tous les endpoints (sauf /health) nécessitent une clé API valide dans l'en-tête X-API-KEY.

Endpoints

POST /api/v1/generate

Traite un fichier et génère du JSON selon la configuration YAML fournie.

Description

Cet endpoint accepte un fichier (PDF, DOCX, XLSX ou image) et un fichier de configuration YAML, puis extrait les données spécifiées et les retourne au format JSON.

En-têtes requis

En-tête	Type	Requis	Description
X-API-KEY	string	Oui	Clé d'accès API

Paramètres de la requête

Paramètre	Type	Requis	Description
file	File (binary)	Oui	Fichier à traiter (PDF ou image)
yaml_file	File (binary)	Oui	Fichier YAML décrivant les champs à extraire

Types de fichiers supportés

Formats d'entrée :

• PDF
• JPG, JPEG
• PNG
• DOCX
• XLSX
• TEXT

Limites :

• Taille maximale : 1-100 MB

Exemple de requête

curl -X POST "https://api.parsemyfile.com/api/v1/generate" \
  -H "X-API-KEY: votre_cle_api_ici" \
  -H "Content-type: multipart/form-data"
  -F "file=@document.pdf" \
  -F "yaml_file=@configuration.yaml"

Réponses

200 - Succès

{
  "execution_time": "1.5",
  "status": "success",
  "data": {
    "client": {
      "nom": "Jean Dupont",
      "email": "jean.dupont@example.com",
      "telephone": "0123456789",
      "adresse": "123 Rue de la Paix, 75001 Paris"
    }
  }
}

Pour le détail des erreurs voir la rubrique Gestion des erreurs

GET /health

Vérifie l'état de santé de l'API.

Description

Cet endpoint permet de vérifier que l'API fonctionne correctement et est accessible.

En-têtes requis

Aucun en-tête requis.

Paramètres

Aucun paramètre requis.

Exemple de requête

curl -X GET "https://api.parsemyfile.com/health"

Réponses

200 - API en bonne santé

{
  "status": "healthy",
  "timestamp": "2024-01-15T10:30:00Z",
  "version": "1.0.0",
}

Codes de statut HTTP

Code	Description	Quand l'utiliser
200	Succès	Requête traitée avec succès
400	Requête malformée	Paramètres invalides ou format non supporté
401	Non autorisé	Clé API manquante ou invalide
402	Paiement requis	Abonnement expiré ou crédit insuffisant
422	Erreur de validation	Données de requête invalides
500	Erreur interne	Erreur côté serveur
503	Service indisponible	API temporairement indisponible

Formats de données

Format d'entrée

Les fichiers doivent être envoyés en multipart/form-data avec les champs :

• file : Le fichier à traiter
• yaml_file : La configuration YAML

Format de sortie

Toutes les réponses sont au format JSON avec l'encodage UTF-8.

Structure des réponses

Réponse de succès

{
  "execution_time": 2.333,
  "status": "success|error",
  "data": {
   /* Information extrait du document */
  },
  
}

Réponse d'erreur

{
  "details": { /* Détails supplémentaires */ }
}

Sécurité

Authentification

• Utilisez HTTPS pour toutes les requêtes
• Gardez votre clé API secrète
• Ne commitez jamais votre clé API dans le code source
• Utilisez des variables d'environnement pour stocker la clé

Validation des données

• L'API valide automatiquement tous les paramètres d'entrée
• L'API ne garantit pas l'exactitude des informations retournées

Confidentialité

• Les fichiers ne sont pas stockés
• Aucune donnée n'est stockée
• Les logs ne contiennent pas d'informations sensibles