Arsitektur Dokumentasi

Memahami path dasar API, host, dan perilaku lingkungan.

Path dasar

Tulis menyediakan dua permukaan API yang berbeda:

Panduan ini mencakup public API (/v1). Rute admin (mis. POST /api/api-keys untuk menghasilkan kunci) menggunakan auth JWT dan memerlukan peran workspace.

Base URL publik yang lengkap adalah:

https://YOUR_HOST/v1

Rute publik meliputi: GET /v1/posts, GET /v1/posts/{slugOrId}, GET /v1/taxonomies, GET /v1/media, GET /v1/posts/:post_id/comments, POST /v1/comments, GET /v1/workspaces/:id/sitemap, dan GET /v1/og-image/:id.

Host: self-host vs di-host

Self-host (sumber terbuka). Host adalah domain Anda sendiri. Dikonfigurasi melalui variabel lingkungan API_HOST. Di produksi, APISubdomainGuard memerlukan header Host yang masuk untuk cocok dengan host yang dikonfigurasi — permintaan ke host yang tidak dikenal akan ditolak. Di pengembangan (localhost), pengaman ini dilewati untuk kemudahan.

Di-host / admin yang dibeli. Gunakan host yang diberikan kepada Anda saat membeli instance Tulis yang di-host. Anda tidak mengkonfigurasi API_HOST sendiri.

Header yang diperlukan

Terlepas dari host, setiap permintaan publik memerlukan:

Authorization: Bearer *** X-Workspace-ID: YOUR_WORKSPACE_ID

(atau alternatif subdomain workspace — lihat authentication.md).

Rate limiting & CORS

• Rate limiting berlaku untuk API. Hormati header respons batas kecepatan dan mundur saat dibatasi.
• CORS diaktifkan, sehingga frontend berbasis browser dapat memanggil API publik secara langsung (dengan syarat konteks workspace dan kunci API seperti di atas).