Saltar al contenido principal

Encuentra tu próxima herramienta

API/Referencia/Procesar un documento
POST/api/v1/documents/{documentId}/process

Procesar un documento

Crea un trabajo de procesamiento asíncrono para una versión de un documento de la cuenta.

Autenticación

Clave de API o autenticación de la cuenta

Permisos

documents:read, jobs:create

Contrato

API v1

Solicitud

curl -X POST 'https://api.maxscanner.app/api/v1/documents/{documentId}/process' \
  -H 'Authorization: Bearer $MAXSCANNER_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: unique-request-id' \
  -d '{ "operation": "convert", "format": "pdf" }'

Cuerpo de la solicitud

{ "operation": "convert", "format": "pdf" }

Respuesta

{ "jobId": "job_123", "documentId": "doc_123", "versionId": "ver_4", "status": "queued" }

Notas de implementación

  • El servidor valida la propiedad del documento antes de encolarlo.
  • Usa el jobId devuelto para seguir el estado.

Prueba este endpoint

Usa el entorno de pruebas de la API para autenticarte y probar con seguridad antes de integrar el endpoint en tu aplicación.

Abrir el entorno de pruebas →