Dokumentasi Resmi
|tulis.org

Arsitektur Dokumentasi

Peta jalan panduan, SDK integration, dan API reference lengkap yang disiapkan secara terstruktur.

TULIS CMS/DEVELOPER HUB
/api-reference-seo-og-image

Gambar Open Graph (OG)

Melihat gambar Open Graph (OG) yang dihasilkan secara otomatis untuk sebuah posting. Endpoint ini bersifat publik.

Endpoint

GET /v1/og-image/:id

Autentikasi

Tidak diperlukan kunci API untuk mengakses gambar yang dihasilkan; namun, header `Authorization: Bearer *** biasanya tetap diterima/diharapkan tergantung pada konfigurasi deployment.

Parameter Path

ParameterTipeDeskripsi
idUUIDID posting.

Respons

Mengembalikan gambar biner (biasanya image/png atau image/jpeg). Gunakan URL langsung di tag meta Open Graph halaman Anda:

<meta property="og:image" content="https://YOUR_HOST/v1/og-image/3f1a2b9c-7e4d-4c8a-9b21-0c5d6e7f8a90" />

Gambar yang dihasilkan menyematkan judul posting, gambar fitur, dan merek workspace, cocok untuk pratinjau berbagi sosial di platform seperti Facebook, Twitter/X, dan LinkedIn.

Contoh cURL / Penggunaan

Pengambilan gambar langsung:

curl "https://YOUR_HOST/v1/og-image/3f1a2b9c-7e4d-4c8a-9b21-0c5d6e7f8a90" \
  -o og-image.png

Gunakan dalam kartu berbagi sosial:

curl "https://YOUR_HOST/v1/og-image/3f1a2b9c-7e4d-4c8a-9b21-0c5d6e7f8a90" \
  -H "Authorization: Bearer ***" \
  -o share-card.jpg

Lini Masa Peluncuran Fitur

Fase 1: Setup Awal & KonfigurasiSELESAI

Docker Compose, pengaturan file environment, dan panduan setup lokal telah lengkap dibuat.

Fase 2: Referensi RESTful APISELESAI

Dokumentasi route endpoint publik, otentikasi JWT, dan kontrol hak akses telah selesai disusun.

Fase 3: Integrasi Frontend & Fitur LanjutSEDANG BERJALAN

Mempersiapkan boilerplate untuk Next.js client, manajemen revisi konten, dan optimasi query.