API de MAXScanner v1
Crea flujos de documentos, no infraestructura de procesamiento.
API asíncronas para documentos, archivos, OCR, conversión, PDF, compresión y webhooks. Un modelo de autenticación, un ciclo de vida de trabajos y un contrato de resultados.
Autenticación
Claves de API con permisos limitados
Procesamiento
Trabajos asíncronos
Eventos
Webhooks firmados
Referencia
Todas las operaciones de la API
/api/v1/jobsCrear un trabajo de procesamiento
Envía una operación de procesamiento asíncrona y recibe un identificador de trabajo estable.
/api/v1/jobs/{jobId}Consultar el estado de un trabajo
Lee el estado actual del ciclo de vida y la información del resultado de un trabajo de procesamiento.
/api/v1/documentsListar documentos
Lista los documentos disponibles para la cuenta autenticada.
/api/v1/documents/{documentId}/processProcesar un documento
Crea un trabajo de procesamiento asíncrono para una versión de un documento de la cuenta.
/api/v1/files/uploadAutorizar la subida de un archivo
Crea un flujo de subida acotado para un archivo de origen privado.
/api/v1/convertConvertir un archivo
Envía una conversión de documento compatible a través de la flota de procesadores gestionada.
/api/v1/ocrEjecutar OCR
Extrae texto buscable de una imagen o un documento compatible.
/api/v1/pdfEjecutar una operación de PDF
Envía una operación de PDF compatible, como unir, dividir u optimizar.
/api/v1/compressComprimir una imagen
Envía un trabajo de optimización de imagen con restricciones de formato y calidad.
/api/v1/webhooksCrear un webhook
Registra un destino de callback firmado para eventos de trabajos y documentos.
Error referenceReferencia de errores
Comprende los errores de autenticación, validación, cuota, conflicto y servidor.
Limits & formatsLímites y formatos
Consulta los formatos compatibles, las cuotas y las restricciones de las solicitudes.