PDFLean
Riferimento API

API Workflow

Tutti gli endpoint richiedono una sessione di accesso (cookie) se non diversamente specificato. Le risposte sono JSON: { ok: true, data } o { ok: false, error }. Errori comuni: 400 validazione, 401 non autenticato, 403 accesso negato, 404 non trovato, 429 troppi tentativi, 502/503 upstream. Gli endpoint pubblici /api/v1 si autenticano con Authorization: Bearer pdflean_… e devono inviare un content type JSON.

In questa pagina

Flussi di lavoro

MetodoPercorsoDescrizione
GET/api/workflowsElenca i tuoi flussi di lavoro
POST/api/workflowsCrea un flusso di lavoro (bozza)
GET/api/workflows/:idOttieni un flusso di lavoro
PUT/api/workflows/:idAggiorna un flusso di lavoro (bozza, versione+1)
DELETE/api/workflows/:idElimina un flusso di lavoro
POST/api/workflows/:id/publishPubblica una versione
GET/api/workflows/:id/versionsElenca le versioni
POST/api/workflows/:id/versions/:version/restoreRipristina una versione

Trigger e Hook

MetodoPercorsoDescrizione
GET/api/workflows/triggersElenca i trigger
POST/api/workflows/triggersCrea un trigger (webhook/pianificazione/email/drive)
POST/api/workflows/triggers/:id/runEsegui un trigger ora
DELETE/api/workflows/triggers/:idElimina un trigger
POST/api/workflows/hook/:tokenWebhook in entrata (autenticazione tramite token, nessuna sessione; corpo JSON)

Esecuzioni e revisioni

MetodoPercorsoDescrizione
POST/api/workflows/runsCrea un'esecuzione (in coda)
GET/api/workflows/runsElenca esecuzioni
GET/api/workflows/runs/:idDettagli dell'esecuzione e dei passaggi
POST/api/workflows/runs/:id/retryRiprova un'esecuzione fallita/in coda
GET/api/workflows/reviewsRevisioni umane in attesa
POST/api/workflows/reviews/:idApprova/rifiuta una revisione

Ponte Cloud

MetodoPercorsoDescrizione
GET/api/workflows/cloud/statusStato del bridge VPS indipendente
POST/api/workflows/cloud/convertOffice → PDF tramite VPS indipendente (LibreOffice)
POST/api/workflows/cloud/ocrOCR tramite VPS indipendente (Tesseract)
POST/api/workflows/cloud/extractEstrai campi fattura/generici da PDF (pdfjs + regole)

Archivio e conservazione

MetodoPercorsoDescrizione
GET/api/workflows/archiveElenca i documenti archiviati e l'integrità della catena
POST/api/workflows/archiveArchivia un documento (base64, catena di hash SHA-256)
GET/api/workflows/archive/:id/verifyVerifica la catena di hash dell'archivio
GET/api/workflows/archive/exportEsporta CSV di audit dell'archivio (include tombstone)
POST/api/workflows/archive/:id/holdImposta/rimuovi conservazione legale
POST/api/workflows/archive/:id/complianceAbilita blocco di conformità WORM irreversibile
DELETE/api/workflows/archive/:idElimina un archivio (bloccato in caso di conservazione legale)

API Pubblica v1

MetodoPercorsoDescrizione
GET/api/v1/openapi.jsonSpecifica OpenAPI 3.1 (pubblica, senza autenticazione)
GET/api/v1/meProprietà corrente della chiave API (chiave Bearer)
GET/api/v1/usageDashboard d'uso: saldo, storico di 30 giorni, chiamate recenti
GET/api/v1/workflowsElenco dei workflow (scope workflow.read)
GET/api/v1/workflows/:idOttenere un workflow (scope workflow.read)
POST/api/v1/workflows/:id/runAccodare un'esecuzione (scope workflow.run)
GET/api/v1/runsElenco delle esecuzioni (scope workflow.read)
POST/api/v1/pdf/mergeUnisci PDF (scope pdf.merge; 2–10 file in base64)
POST/api/v1/pdf/splitMantieni le pagine selezionate (scope pdf.split; intervalli come "1-3,5")
POST/api/v1/pdf/compressComprimi strutturalmente un PDF (scope pdf.compress)
GET/api/v1/jobs/:idStato del job (gratuito)
GET/api/v1/jobs/:id/downloadScarica il risultato di un job (gratuito)
POST/api/v1/convert/officeConverti documenti Office/ODF (scope pdf.convert)
POST/api/v1/convert/linearizeLinearizza un PDF per una visualizzazione web rapida (scope pdf.convert)
POST/api/v1/convert/typstCompila sorgenti Typst/Markdown in PDF (scope pdf.convert)
POST/api/v1/ocrEsegui OCR di un PDF scansionato in un PDF ricercabile (scope pdf.ocr)
POST/api/v1/ocr/textOCR di una singola immagine in testo (scope pdf.ocr)
POST/api/v1/validate/pdfaVerifica di conformità PDF/A (scope pdf.validate)
POST/api/v1/validate/pdfuaVerifica di accessibilità PDF/UA (scope pdf.validate)
POST/api/v1/validate/signatureRapporto di verifica della firma digitale (scope pdf.validate)
POST/api/v1/signFirma digitale PAdES (scope pdf.sign; coppia di chiavi PEM opzionale)
POST/api/v1/redactRedazione effettiva di corrispondenze testuali o aree (scope pdf.redact)
POST/api/v1/extractEstrazione di campi basata su testo e regole (scope pdf.extract)
POST/api/v1/doclingAnalisi del layout strutturato tramite Docling (scope pdf.extract)
POST/api/v1/scan/piiScansiona il testo per informazioni personali (scope pii.detect)

Credit consumption

Member credits refresh each billing cycle (no rollover) and are spent before purchased credits. Credits are $0.001 each.

Top up API credits in your account (from $5, never expires)

MethodEndpointCredits
GET/jobs/:id0 per call
GET/jobs/:id/download0 per call
GET/me0 per call
GET/runs0 per call
GET/usage0 per call
GET/workflows0 per call
GET/workflows/:id0 per call
POST/ai/chat3 per call
POST/ai/extract5 per call
POST/ai/pii-detect4 per call
POST/ai/summarize3 per call
POST/ai/translate3 per call
POST/convert/linearize1 per call
POST/convert/office2 per call
POST/convert/typst1 per call
POST/docling3 per call
POST/extract2 per call
POST/ocr3 per page
POST/ocr/text1 per call
POST/pdf/compress1 per call
POST/pdf/merge1 per call
POST/pdf/split1 per call
POST/redact3 per call
POST/scan/pii2 per call
POST/sign5 per envelope
POST/validate/pdfa2 per call
POST/validate/pdfua2 per call
POST/validate/signature2 per call
POST/workflows/:id/run1 per call
ai.chat2 per call
convert.html_to_pdf4 per page
convert.office_to_pdf10 per page
convert.pdf_to_office12 per page
convert.pdfa8 per page
esign.envelope750 per envelope
pdf.ocr3 per page
pdf.ocr.high8 per page