API PDF per Shopify per app e processi backend
Chiamate gPdf da una app Shopify o da un processo backend per generare PDF ordine, fatture, distinte di imballaggio, resi ed etichette da dati Shopify mappati.
/api/v1/pdf/render Usare una app Shopify o un backend ecommerce per mappare dati di ordine, cliente, prodotto, evasione e reso in JSON gPdf o dati template, poi restituire PDF deterministici senza dichiarare una integrazione nativa nello Shopify App Store.
Quando usare questa API
- State costruendo una app Shopify, un backend privato o un processo di evasione ordini che può chiamare API esterne.
- La vostra app riceve già dati Shopify su ordini, evasione, clienti o prodotti.
- Vi servono fatture, distinte di imballaggio, documenti di reso, etichette di magazzino o allegati PDF.
- Volete un contratto template_id stabile per layout documentali specifici del merchant.
Cosa non sostituisce
- Vi aspettate che gPdf sia una app Shopify ufficiale o un listing nell'App Store.
- Vi serve che gPdf si installi nello store del merchant, gestisca OAuth o si iscriva direttamente ai webhook.
- Vi servono tariffe di spedizione, acquisto affrancatura, gestione inventario o funzionalità UI merchant da gPdf.
Quale endpoint chiamare
/api/v1/pdf/render
JSON Render è il percorso predefinito per questo flusso.
/api/v1/template-render
Usalo quando il flusso richiede l'API collegata, un contratto di template o una verifica delle capacità.
Request minimo
POST /api/v1/template-render - il backend della app invia dati ordine Shopify mappati a un template pubblicato.
{
"template_id": "packing_list",
"data": [
{
"order_number": "#1042",
"customer_name": "Example Buyer",
"ship_to": "1200 Market St, San Francisco, CA",
"items": [
{ "sku": "TSHIRT-BLK-M", "name": "Black T-shirt", "quantity": 2 },
{ "sku": "MUG-WHT", "name": "White mug", "quantity": 1 }
]
}
]
}
Cosa gestisce gPdf
- Rendering PDF da JSON derivato da Shopify e mappato dal backend della vostra app.
- Template Render per layout documentali specifici di merchant o brand.
- Codici a barre, QR code, tabelle, totali, immagini, etichette e strutture di distinta di imballaggio.
- Generazione PDF stateless tramite le API pubbliche gPdf.
Cosa controlla il tuo sistema
- Codice della app Shopify, OAuth, webhook, UI merchant e distribuzione app-store.
- Mappatura di dati ordine, evasione, cliente, reso, prodotto e fiscali.
- Configurazione merchant, selezione template, consegna, conservazione e retry.
Checklist di produzione
- Mantenete credenziali Shopify e token API gPdf nel backend, non nel codice browser.
- Mappate i dati Shopify in una richiesta di rendering esplicita o in uno schema dati per template.
- Usate Template Render per layout specifici del merchant dopo l'approvazione.
- Conservate PDF generati o dati sorgente secondo il processo del merchant.
- Documentate che l'integrazione è la vostra app che chiama gPdf, non una app Shopify ufficiale di gPdf.
Limiti della promessa
- Non dichiarate una app Shopify ufficiale pubblica se non esiste.
- gPdf non gestisce OAuth Shopify, installazione app, webhook o impostazioni merchant.
- Il sistema chiamante possiede mappatura dei dati Shopify e regole di business ecommerce.
Modello di integrazione
Il modello di integrazione Shopify più pulito è backend-to-backend. La vostra app riceve o recupera dati Shopify, li mappa in un DocumentRequest gPdf o in un oggetto data per template, chiama gPdf e restituisce o conserva il PDF secondo il processo del merchant.
Questo mantiene accurata la promessa pubblica: gPdf è l’API di generazione PDF che la vostra app Shopify può chiamare. Non è una app Shopify ufficiale pubblica, a meno che quel prodotto separato esista.
Template Render si adatta ai layout merchant
I PDF ecommerce spesso diventano specifici del merchant: branding, tabelle articoli, istruzioni di reso, blocchi etichetta, note regalo e testo localizzato. Template Render consente alla vostra app di mantenere quei layout in template pubblicati mentre l’app invia solo i dati ordine mappati.
Tenete la logica di piattaforma nella app
OAuth, webhook, impostazioni merchant, stato di evasione ordini, inventario, regole di reso e distribuzione app-store restano nella vostra app Shopify. gPdf dovrebbe ricevere i dati finali di rendering e produrre il PDF.
FAQ
- gPdf è una app Shopify ufficiale?
- No. Questa pagina è per app e backend che chiamano gPdf. Non presentate gPdf come una integrazione ufficiale nello Shopify App Store se quel prodotto non esiste.
- Dove deve avvenire la chiamata API a gPdf?
- Chiamate gPdf dal vostro backend o app server, dove credenziali Shopify e token API gPdf sono protetti.
- I PDF Shopify dovrebbero usare JSON Render o Template Render?
- Usate JSON Render per layout generati su misura. Usate Template Render quando un layout merchant o brand è approvato e i sistemi chiamanti devono inviare solo dati.
- gPdf gestisce webhook Shopify?
- No. La vostra app riceve webhook, mappa i dati e decide quando renderizzare. gPdf renderizza solo la richiesta PDF che riceve.