Guida al prodotto e alle API

Link di anteprima

Impostazioni del visualizzatore e dell'incorporamento

Configura aspetto, visibilità del titolo e navigazione nelle impostazioni del visualizzatore incorporato dell'account. Rimozione del marchio e incorporamento dipendono dal piano: controlla la disponibilità mostrata nel pannello.

Siti consentiti

Aggiungi i siti in cui incorporerai il visualizzatore ai siti consentiti. Permesso di incorporamento e validità della condivisione sono controlli separati: consentire un sito non riattiva una condivisione scaduta o revocata. Non inserire mai una chiave API nel codice del browser o nell'URL di un iframe.

Controlla prima di condividere

Prova il link nelle condizioni del destinatario. Controlla pagine, layout di grafici e tabelle, formati scaricabili e scadenza. Prova anche l'incorporamento su un sito non consentito: un'anteprima funzionante nell'account non dimostra da sola che l'accesso esterno sia abilitato.

Crea un link di visualizzazione a scadenza che il cliente può aprire senza account. Una sola chiamata può restituire link di download sia PDF sia DOCX.

Richiesta 
curl -X POST https://api.pdfgine.com/api/v1/preview \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "templateCode": "invoice", "formats": ["pdf", "docx"], "data": { } }'
Risposta 
{
  "previewId": "prv_481fac83d9f14a4493021eb128d0876b",
  "previewUrl": "/p/prv_481fac83d9f14a4493021eb128d0876b",
  "expiresAt": "2026-08-29T13:23:43+00:00",
  "pageCount": 1,
  "downloads": [
    { "format": "pdf", "downloadUrl": "/api/v1/previews/prv_481f.../download/pdf?expires=...&token=..." },
    { "format": "docx", "downloadUrl": "/api/v1/previews/prv_481f.../download/docx?expires=...&token=..." }
  ]
}

Il link contiene una firma non indovinabile e si chiude a expiresAt.

Per quanto tempo restano disponibili i documenti

PDFgine genera e consegna documenti; conservarli è una tua scelta. Il prodotto mantiene solo i propri input (modelli, risorse del brand) e output temporanei. Ogni output resta per il periodo scelto nella richiesta: accessProfile: short 24 ore (predefinito), standard 7 giorni, extended 30 giorni (7 e 30 giorni da Go in su), quarter 90 giorni (Max). Un link di condivisione resta aperto per quel periodo; un documento di produzione (/render, /documents/render) può essere riscaricato tramite API nello stesso periodo. Alla scadenza i download restituiscono 410 e l'output viene eliminato entro 24 ore; record di generazione, conteggio pagine e dati di utilizzo restano. Per conservare un documento in modo permanente, salvalo nel tuo sistema subito dopo la generazione.

Link di novanta giorni

Oltre ai profili standard ed extended esiste il profilo quarter, che mantiene valido un link per 90 giorni, ad esempio per un contratto che l'altra parte deve poter riaprire per un intero trimestre. È disponibile nel piano più alto; ogni piano mostra i profili utilizzabili tra le proprie funzionalità incluse.

Chiudere un link in anticipo

Un link di condivisione si chiude normalmente a expiresAt. Se il documento non deve più essere visibile, revocalo: la risposta è 204 e il link smette subito di funzionare.

cURL 
curl -i -X POST https://api.pdfgine.com/api/v1/previews/prv_481fac83d9f14a4493021eb128d0876b/revoke \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

HTTP/1.1 204 No Content

Gli errori più comuni

  • La creazione di un'anteprima risponde 201, non 200; la revoca risponde 204 senza corpo. Un client che analizza ogni risposta come JSON fallisce sulla revoca.
  • accessProfile determina la durata del link e i profili più lunghi richiedono il piano adatto. Richiedere quarter con un piano che non lo include viene rifiutato, non abbreviato in silenzio.
  • I link in downloads contengono una firma e una scadenza. Salva previewId, non quegli indirizzi: un indirizzo memorizzato smette di funzionare alla scadenza.
  • La revoca chiude il link, non il documento. Il file resta tuo e puoi ancora scaricarlo tramite API fino alla fine della conservazione.
  • Un'anteprima consuma pagine di anteprima, non quota di produzione. Produrre di nuovo lo stesso documento con /render comporta un conteggio separato di pagine fatturabili.