Aller au contenu principal

API REST

Une API d'extraction de documents qui renvoie un JSON propre.

Envoyez un PDF, une image ou un fichier bureautique avec votre clé API et récupérez des champs typés, avec le type de document détecté et un score de confiance. En mode synchrone, ou laissez DocuSense appeler votre webhook quand le document est prêt.

L'API est disponible sur tous les forfaits, y compris le gratuit (factures et champs personnalisés). Feuillets fiscaux et talons de paie à partir du forfait Pro.

Développer votre propre lecture de documents prend des mois

  • Chaque fournisseur, employeur et banque a sa propre mise en page, et les gabarits cassent au premier changement.

  • Un OCR seul renvoie du texte, pas les champs, types et totaux dont votre application a besoin.

  • Les résultats incertains doivent être interceptés avant d'arriver dans votre base de données.

Comment ça marche

  1. Créer une clé

    Créez une clé API dans le tableau de bord avec seulement les permissions utiles : lecture, écriture ou suppression.

  2. Envoyer le fichier

    Envoyez le fichier en base64 dans un JSON avec documentType AUTO, ou le type attendu. Les lots acceptent un ZIP ou un PDF de plusieurs pages.

  3. Recevoir le JSON

    Obtenez le type de document, un score de confiance, les champs extraits, le résultat des contrôles et un indicateur de vérification.

  4. Automatiser

    Utilisez les tâches asynchrones, les lots et les webhooks signés pour réagir dès qu'un document est traité.

Types de documents disponibles par l'API

Le même point d'accès gère tous les types; AUTO les détecte pour vous.

Tous les forfaits

  • Factures
  • Champs personnalisés sur tout document

Forfait Pro et plus

  • Relevés bancaires
  • T4, W-2, P60, P45
  • Relevé d'emploi (RE)
  • Talons de paie canadiens et européens

Forfait Ultra et plus

  • Relevé 1 du Québec
  • Avis d'imposition (France)
  • Contrats

Une réponse, telle que votre code la reçoit

Appel synchrone sur une facture (données extraites abrégées pour la lecture).

POST /api/v1/documents
{
  "success": true,
  "data": {
    "id": "8f3c2b1e-4a5d-4c6e-9f70-1a2b3c4d5e6f",
    "status": "COMPLETED",
    "documentType": "INVOICE",
    "classificationConfidence": 0.98,
    "reviewRequired": false,
    "checkStatus": "ok",
    "extractedData": {
      "invoiceNumber": "INV-0425",
      "vendor": {
        "name": "Example Supplies Inc."
      },
      "total": 1195.74,
      "currency": "CAD"
    }
  }
}

Formats et limites

Ce que vous pouvez envoyer

  • PDF, PNG, JPG, WEBP, Word (.docx), Excel (.xlsx), CSV
  • Un fichier en base64 dans un JSON; les lots en envoi binaire (ZIP ou PDF)
  • Jusqu'à 10 Mo par fichier; fichiers ZIP en lot

Ce que vous récupérez

  • JSON typé avec type de document et score de confiance
  • Export CSV d'un document
  • Webhooks signés HMAC-SHA256 avec horodatage

Bon à savoir

  • Les limites de débit et le quota mensuel de pages dépendent du forfait; chaque réponse indique les limites dans ses en-têtes.
  • Gardez votre clé sur votre serveur : jamais dans un navigateur, une application mobile ou un dépôt public.

Conçue pour la production

  • Les clés API sont stockées hachées, peuvent être limitées à la lecture, l'écriture ou la suppression, et cessent de fonctionner dès leur révocation.
  • Les webhooks sont signés avec un horodatage : votre serveur peut rejeter les appels falsifiés ou rejoués.
  • Les fichiers d'origine sont supprimés après traitement et les identifiants comme le NAS sont masqués.

Questions fréquentes

L'API est-elle synchrone ou asynchrone ?

Les deux. Un appel synchrone renvoie les données extraites dans la réponse. Pour les longs documents ou les lots, utilisez les tâches asynchrones et un webhook, ou interrogez la tâche.

Quels langages couvrent les exemples de code ?

cURL, Python, Node.js, PHP, Ruby, Go, Java, C# (.NET), VB.NET, C, C++, Kotlin, Swift, Dart, Rust et PowerShell, générés à partir de la spécification OpenAPI.

Comment savoir si un résultat est fiable ?

Chaque réponse contient le type détecté, un score de confiance de classification, le résultat des contrôles automatiques et un indicateur reviewRequired. Envoyez les documents signalés en vérification humaine.

Existe-t-il une spécification OpenAPI ?

Oui. Le fichier OpenAPI complet est public et s'importe dans Postman ou tout outil OpenAPI.

Puis-je l'essayer gratuitement ?

Oui. Le forfait gratuit inclut 50 pages par mois et 100 pages de bienvenue, pour les factures et les champs personnalisés par l'API.

Intégrez l'extraction de documents cette semaine.

Créez un compte gratuit, générez une clé API et faites votre premier appel en quelques minutes.