API MAXScanner v1
Construisez des flux documentaires, pas une infrastructure de traitement.
Des API asynchrones pour les documents, fichiers, l’OCR, la conversion, le PDF, la compression et les webhooks. Un seul modèle d’authentification, un seul cycle de vie des tâches et un seul contrat de résultat.
Authentification
Clés d’API à portée limitée
Traitement
Tâches asynchrones
Événements
Webhooks signés
Référence
Toutes les opérations de l’API
/api/v1/jobsCréer une tâche de traitement
Soumettez une opération de traitement asynchrone et recevez un identifiant de tâche stable.
/api/v1/jobs/{jobId}Consulter l’état d’une tâche
Lisez l’état actuel du cycle de vie et les informations de résultat d’une tâche de traitement.
/api/v1/documentsLister les documents
Liste les documents accessibles au compte authentifié.
/api/v1/documents/{documentId}/processTraiter un document
Créez une tâche de traitement asynchrone pour une version d’un document du compte.
/api/v1/files/uploadAutoriser l’envoi d’un fichier
Créez un flux d’envoi borné pour un fichier source privé.
/api/v1/convertConvertir un fichier
Acheminez une conversion de document prise en charge via la flotte de processeurs gérée.
/api/v1/ocrLancer l’OCR
Extrayez un texte consultable d’une image ou d’un document pris en charge.
/api/v1/pdfLancer une opération PDF
Soumettez une opération PDF prise en charge, comme la fusion, la division ou l’optimisation.
/api/v1/compressCompresser une image
Soumettez une tâche d’optimisation d’image avec des contraintes de format et de qualité.
/api/v1/webhooksCréer un webhook
Enregistrez une destination de callback signée pour les événements de tâches et de documents.
Error referenceRéférence des erreurs
Comprenez les erreurs d’authentification, de validation, de quota, de conflit et de serveur.
Limits & formatsLimites et formats
Consultez les formats pris en charge, les quotas et les contraintes des requêtes.