Riferimento API per le immagini OG

Il riferimento API per le immagini OG copre l'endpoint, i parametri e il catalogo dei template per generare immagini Open Graph dinamiche con FastOG. L'API è soggetta a sottoscrizione — è richiesto un piano Dynamic API attivo, ma i render stessi non sono conteggiati: non esiste una quota mensile di render né una fatturazione per eccedenza. Gli URL firmati con HMAC mantengono sicura ogni richiesta. Registrati, scegli un piano Dynamic API, poi crea la tua chiave API e il tuo segreto HMAC nella dashboard; i render API a pagamento sono puliti. Il contratto OpenAPI generato è l'elenco autorevole leggibile dalla macchina di parametri, codici di errore e slug dei template.

URL di base

https://fastog.com/api/v1/og

Autenticazione

Tutte le richieste richiedono l'autenticazione tramite firma HMAC-SHA256. La key pubblica e la firma s sono parametri di query; l'autenticazione basata su header non è attualmente supportata. Consulta la Documentazione HMAC per i dettagli.

Endpoint

GET /api/v1/og

Genera un'immagine Open Graph dinamica in base ai parametri forniti.

Query Parameters

Parametri specifici del template

Ogni template accetta i parametri condivisi riportati di seguito più i propri parametri specifici (vedi la tabella dell'indice). Il parametro di query template seleziona il layout utilizzato (predefinito: default).

Parametri condivisi (tutti i template)

Indice dei template — 67 slug renderizzabili, 48 selezionabili. La tabella seguente documenta gli stili più usati e le prop relative a ciascun template; l'elenco esaustivo e generato (etichetta, categoria, flag di ritiro e ogni slug accettato) si trova in /openapi.json sotto x-template-catalogue, e i campi dell'editor di ogni template (chiave, etichetta, tipo, valore predefinito, opzioni e formato URL) sono sotto x-template-fields. Gli slug ritirati restano renderizzabili, così gli URL già in circolazione continuano a funzionare, ma non vengono offerti dai selettori.

glassproduct accetta anche cta. I template ecommerce, product, glassproduct e imageright mostrano “Shop now” per impostazione predefinita; imposta cta su un valore vuoto per nascondere la pillola visiva.

Tipi di parametro strutturati

Risposta

• 200 OK — Restituisce i dati dell'immagine PNG
• 401 Unauthorized — Autenticazione non valida o mancante
• 422 Unprocessable — Parametri del template non validi

Risposte di errore

Richiesta di esempio

GET /api/v1/og?template=blog&title=Hello%20World&subtitle=A%20test%20post&key=sk_quick_123abc&s=a1b2c3...

Esempio cURL

curl "https://fastog.com/api/v1/og?template=blog&title=Hello%20World&key=sk_quick_123abc&s=<signature>"

Prezzi e limiti

FastOG è subordinato all'abbonamento: è richiesto un piano Dynamic API attivo. I render non sono a consumo — non esiste una quota mensile di render né una fatturazione per eccedenza. Il piano è il requisito di accesso, e ogni livello esegue i render senza un contatore. Consulta Prezzi per i livelli e i prezzi attuali.

Le immagini in cache sono gratuite: le richieste servite dalla cache edge di Cloudflare (stesso template + parametri, indipendentemente dalla firma s su un URL precedentemente messo in cache) non raggiungono mai l'origine, quindi un URL identico non consuma un altro render.

Pulito per impostazione predefinita: ogni render è pulito — nessuna filigrana su alcun piano, e nessuna sul tester OG Image gratuito, sulle anteprime di Studio o sulle esportazioni di Studio. Una render prop fastog_watermark è comunque supportata per i chiamanti che richiedono esplicitamente un badge "Made with FastOG", ma nulla la imposta automaticamente.

Correlati

• Documentazione — Tutte le guide e i riferimenti di FastOG
• Tester gratuito per immagini OG — Anteprima senza un account
• Guida rapida — include il flusso dell'architettura (firma al momento del render)
• Guida alla firma HMAC
• Validazione HMAC
• Tutorial JavaScript