Intégrez facilement notre solution de traitement de documents dans vos applications
DataScribe API vous permet d'envoyer des documents (PDF, images) pour traitement automatique et de recevoir les résultats via webhook ou par interrogation directe.
Note : Cette API est conçue pour les clients qui ont leur propre système et souhaitent uniquement utiliser nos capacités de traitement de documents.
Créez un compte pour obtenir votre première clé API et commencer à utiliser le service.
/auth/register
Important : La clé API n'est affichée qu'une seule fois lors de la création. Conservez-la en lieu sûr !
Toutes les requêtes API doivent inclure votre clé API dans l'en-tête Authorization :
/client/upload
Envoyez un document pour traitement automatique
Paramètre | Type | Requis | Description |
---|---|---|---|
file | File | Oui | Le fichier à traiter (PDF ou image) |
webhook_url | String | Non | URL pour recevoir les notifications |
metadata | JSON String | Non | Métadonnées additionnelles |
/client/documents/{documentId}
Récupérez le statut et les résultats d'un document
pending
: En attente de traitementprocessing
: Traitement en courscompleted
: Traitement terminé avec succèsfailed
: Échec du traitement/client/upload
Listez tous vos documents uploadés
limit
: Nombre de résultats (défaut: 20)offset
: Décalage pour la pagination (défaut: 0)status
: Filtrer par statutLes webhooks vous permettent de recevoir des notifications en temps réel sur le statut de vos documents.
Spécifiez l'URL de votre webhook lors de l'envoi du document :
Envoyé immédiatement après réception du document
Envoyé quand le traitement est terminé avec succès
Envoyé en cas d'échec du traitement
/client/api-keys
Créez une nouvelle clé API
*
: Accès complet (recommandé)documents:read
: Lecture des documentsdocuments:write
: Upload de documentsextraction
: Extraction OCRclient
: Accès aux endpoints clienttext:process
: Traitement de texteusage:read
: Statistiques d'usagetenant:read
: Informations du tenantCode HTTP | Description | Solution |
---|---|---|
400 | Requête invalide | Vérifiez les paramètres envoyés |
401 | Non authentifié | Vérifiez votre clé API |
403 | Permissions insuffisantes | Vérifiez les scopes de votre clé API |
404 | Ressource non trouvée | Vérifiez l'ID du document |
409 | Conflit | L'email est déjà utilisé |
413 | Fichier trop volumineux | Limitez à 50MB par fichier |
422 | Format non supporté | Utilisez PDF, JPEG, PNG, TIFF, BMP ou WEBP |
429 | Trop de requêtes | Réduisez la fréquence des appels |
500 | Erreur serveur | Réessayez plus tard ou contactez le support |
Notre équipe technique est là pour vous accompagner dans l'intégration