Guide de démarrage

Ce guide vous accompagne dans vos premiers pas avec l'API ParseMyFile.

Vue d'ensemble

L'API ParseMyFile permet de traiter des documents PDF, DOCX, XLSX et des images pour extraire des données structurées au format JSON. Elle utilise un fichier de configuration YAML personnalisé pour définir les champs à extraire.

Prérequis

Une clé API valide
Un fichier à traiter (PDF,DOCX,XLSX ou image)
Un fichier de configuration YAML
Un client HTTP (cURL, Postman, ou code dans votre langage préféré)

Installation et configuration

1. Obtenir une clé API

Pour obtenir une clé API, créer un compte sur le site : https://parsemyfile.com. Une fois connecté, rendez-vous dans la rubrique "API Keys". Créer une clé ou utiliser une clé existante valide. Cette clé sera nécessaire pour toutes les requêtes vers l'API.

2. Préparer vos fichiers

Fichier à traiter

Les critères dépendent de votre abonnement

Formats supportés : PDF, JPG, PNG, JEPG, XLSX, DOCX
Taille maximale : 1-10 MB
Qualité recommandée : 300 DPI minimum

Fichier de configuration YAML

Créez un fichier YAML décrivant les champs à extraire.

Voici un exemple :

yaml

schemas:
  data:
    type: object
    properties:
      nom:
        type: string
        description: nom du client
      email:
        type: string
        description: adresse email du client
      telephone:
        type: string
        description: numéro de téléphone du client
      montant:
        type: double
        description: montant total de la facture

Premier appel API

Avec cURL

bash

curl -X POST "https://api.parsemyfile.com/api/v1/generate" \
  -H "X-API-KEY: votre_cle_api_ici" \
  -F "file=@mon_document.pdf" \
  -F "yaml_file=@ma_configuration.yaml"

Avec JavaScript

javascript

const formData = new FormData();
formData.append('file', fileInput.files[0]);
formData.append('yaml_file', yamlFileInput.files[0]);

const response = await fetch('https://api.parsemyfile.com/api/v1/generate', {
  method: 'POST',
  headers: {
    'X-API-KEY': 'votre_cle_api_ici'
  },
  body: formData
});

const result = await response.json();
console.log(result);

Avec Python

python

import requests

url = "https://api.parsemyfile.com/api/v1/generate"
headers = {"X-API-KEY": "votre_cle_api_ici"}

files = {
    'file': ('document.pdf', open('document.pdf', 'rb'), 'application/pdf'),
    'yaml_file': ('configuration.yaml', open('configuration.yaml', 'rb'), 'text/yaml')
}

response = requests.post(url, headers=headers, files=files)
result = response.json()
print(result)

Vérification de l'état de l'API

Avant de traiter vos documents, vous pouvez vérifier que l'API fonctionne correctement :

bash

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

Réponse attendue :

json

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

Guide de démarrage ​

Vue d'ensemble ​

Prérequis ​

Installation et configuration ​

1. Obtenir une clé API ​

2. Préparer vos fichiers ​

Fichier à traiter ​

Fichier de configuration YAML ​

Premier appel API ​

Avec cURL ​

Avec JavaScript ​

Avec Python ​

Vérification de l'état de l'API ​

Prochaines étapes ​