Referensi API Gambar OG

Referensi API gambar OG mencakup endpoint, parameter, dan katalog template untuk menghasilkan gambar Open Graph dinamis dengan FastOG. API ini dibatasi oleh langganan — diperlukan paket Dynamic API yang aktif, tetapi render itu sendiri tidak dihitung: tidak ada kuota render bulanan dan tidak ada tagihan kelebihan pemakaian. URL bertanda tangan HMAC menjaga setiap permintaan tetap aman. Daftar, pilih paket Dynamic API, lalu buat API key dan HMAC secret Anda di dashboard; render API berbayar bersih. Kontrak OpenAPI yang dihasilkan adalah daftar parameter, kode error, dan slug template yang otoritatif dan dapat dibaca mesin.

URL Dasar

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

Autentikasi

Semua permintaan memerlukan autentikasi tanda tangan HMAC-SHA256. key publik dan tanda tangan s adalah parameter kueri; autentikasi berbasis header saat ini tidak didukung. Lihat Dokumentasi HMAC untuk detailnya.

Endpoint

GET /api/v1/og

Menghasilkan gambar Open Graph dinamis berdasarkan parameter yang diberikan.

Parameter Query

Parameter Khusus Template

Setiap template menerima parameter bersama di bawah ini ditambah parameter khusus template-nya (lihat tabel indeks). Parameter query template memilih tata letak yang digunakan (default: default).

Parameter bersama (semua template)

Indeks template — 67 slug yang dapat dirender, 48 yang dapat dipilih. Tabel di bawah ini mendokumentasikan tampilan yang paling sering digunakan dan prop khusus template tersebut; daftar lengkap yang dihasilkan (label, kategori, tanda retired, dan setiap slug yang diterima) ada di /openapi.json pada x-template-catalogue, dan setiap field editor template (key, label, type, default, options, dan format URL) ada pada x-template-fields. Slug yang retired tetap dapat dirender agar URL yang sudah beredar tetap berfungsi, tetapi tidak ditawarkan oleh pemilih.

glassproduct juga menerima cta. Template ecommerce, product, glassproduct, dan imageright menampilkan "Shop now" secara default; setel cta ke nilai kosong untuk menyembunyikan pil visual.

Tipe parameter terstruktur

Respons

• 200 OK — Mengembalikan data gambar PNG
• 401 Unauthorized — Autentikasi tidak valid atau tidak ada
• 422 Unprocessable — Parameter template tidak valid

Respons Error

Contoh Permintaan

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

Contoh cURL

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

Harga & Batasan

FastOG berbasis langganan: diperlukan paket Dynamic API yang aktif. Render tidak dihitung kuotanya — tidak ada kuota render bulanan dan tidak ada tagihan kelebihan pemakaian. Paket adalah gerbangnya, dan setiap tier melakukan render tanpa penghitung. Lihat Harga untuk tier dan harga terkini.

Gambar yang di-cache gratis: permintaan yang dilayani dari cache edge Cloudflare (template + params yang sama, terlepas dari signature s pada URL yang sebelumnya di-cache) tidak pernah mencapai origin, sehingga URL yang identik tidak menghabiskan render tambahan.

Bersih secara default: setiap render bersih — tanpa watermark di paket mana pun, dan tidak ada pada OG Image Tester gratis, pratinjau Studio, maupun ekspor Studio. Prop render fastog_watermark masih didukung untuk pemanggil yang secara eksplisit meminta badge "Made with FastOG", tetapi tidak ada yang menyetelnya secara otomatis.

Terkait

• Dokumentasi — Semua panduan dan referensi FastOG
• Penguji Gambar OG Gratis— Pratinjau tanpa akun
• Panduan Mulai Cepat — mencakup alur arsitektur (tanda tangan saat render)
• Panduan Tanda Tangan HMAC
• Validasi HMAC
• Tutorial JavaScript