Indirizzo di base
Indirizzo di base
Tutti gli endpoint si trovano sotto questo prefisso. In un'installazione locale l'indirizzo predefinito è il valore seguente.
https://api.pdfgine.com/api/v1Paginazione degli endpoint di elenco
Cinque endpoint di elenco supportano la paginazione: /history di un modello, /assets, /marketplace/templates, /templates e /components. Ognuno accetta limit (1-200) e before facoltativi e risponde sempre con un semplice array: chi li legge oggi non deve cambiare nulla.
Senza limit ottieni al massimo 200 righe; se ce ne sono altre, la risposta contiene un'intestazione Link con rel="next". Segui quel link anziché costruire l'URL successivo: il cursore è un numero di versione nella cronologia, un ID risorsa nelle risorse e un valore opaco altrove; solo l'intestazione sa quale. Su /marketplace/templates il cursore contiene anche i filtri, quindi smette di funzionare quando cambiano ricerca, categoria o lingua: è voluto, perché altrimenti punterebbe a un elenco diverso. Gli altri endpoint restituiscono raccolte già limitate. Una risposta troncata include anche X-PDFgine-List-Truncated: true e X-PDFgine-List-Limit, entrambi assenti nell'ultima pagina.
La descrizione leggibile dalle macchine
Tutto ciò che trovi in queste pagine è pubblicato anche come documento OpenAPI 3.0. Usalo nel generatore di client, in Postman o in un editor per ottenere percorsi, corpi delle richieste e payload di esempio senza copiare nulla a mano.
https://api.pdfgine.com/openapi/v1.jsonIl documento viene generato dall'API in esecuzione, quindi descrive la versione che chiami davvero, non quella che qualcuno si è ricordato di documentare.