Vai al contenuto principale

Trova il prossimo strumento

API/Riferimento/Elabora un documento
POST/api/v1/documents/{documentId}/process

Elabora un documento

Crea un job di elaborazione asincrono per una versione di un documento dell’account.

Autenticazione

Chiave API o autenticazione dell’account

Ambiti

documents:read, jobs:create

Contratto

API v1

Richiesta

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" }'

Corpo della richiesta

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

Risposta

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

Note di implementazione

  • Il server verifica la proprietà del documento prima di accodarlo.
  • Usa il jobId restituito per seguire lo stato.

Prova questo endpoint

Usa l’ambiente di prova dell’API per autenticarti e testare in sicurezza prima di integrare l’endpoint nella tua applicazione.

Apri l’ambiente di prova →