Guida al prodotto e alle API

Guida rapida

Cinque minuti al tuo primo documento

Questa pagina ti porta da zero a un PDF su disco. Usa il modello Fattura presente in ogni nuovo spazio di lavoro, quindi non devi prima progettare nulla.

1. La tua chiave

Crea una chiave in Account → Chiavi API. Il segreto viene mostrato una volta: non inserirlo nel codice sorgente. Ogni chiamata lo invia nell'intestazione X-PDFgine-Key.

cURL
# La chiave va nell'ambiente, non nel codice
export PDFGINE_KEY="pdfgine_live_..."

# Funziona? Questa chiamata elenca i tuoi modelli
curl https://api.pdfgine.com/api/v1/templates \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

2. Produci un documento

Una chiamata con il codice del modello e i tuoi dati. La risposta è 202 con documentId e un URL di download.

cURL
curl -X POST https://api.pdfgine.com/api/v1/render \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "templateCode": "invoice",
        "format": "pdf",
        "locale": "it",
        "data": {
          "document": { "title": "Riepilogo fattura" },
          "referenceNo": "DOC-2026-0042",
          "issueDate": "2026-09-06",
          "currency": "USD",
          "customer": "Northwind Trading Ltd.",
          "lineItems": [
            { "name": "Diagnosi del guasto", "quantity": 2, "unitPrice": 850.00 }
          ]
        }
      }'

Quando provi un modello, invia "purpose": "editor-test": l'output non consuma quota e usa la bozza non pubblicata.

3. Scaricalo

L'URL di download nella risposta è relativo all'indirizzo API e si recupera con la stessa chiave. Richiedi docx anziché pdf per ottenere gli stessi dati come file Word.

cURL
curl https://api.pdfgine.com/api/v1/documents/doc_a96063f5dcd5400286ce9b3be9b0595b/download/pdf \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -o invoice.pdf

I primi errori più comuni

  • 402 indica che la quota mensile di pagine è esaurita; l'intestazione X-PDFgine-Quota-Remaining ti avvisa prima di arrivarci.
  • 422 indica che i dati non soddisfano il modello. Il corpo elenca ogni campo mancante sotto errors, senza dover indovinare.
  • La generazione risponde 202, non 200. Un client che considera errore qualsiasi stato diverso da 200 segnalerà un successo come errore.

Come proseguire

Tornerai spesso alla pagina Formati dei dati: spiega esattamente come devono arrivare date, importi e valute.

Formati dei dati →