Arsitektur & Spesifikasi REST API

Spesifikasi resmi OpenAPI 3.1, daftar Base URL, dan prinsip arsitektur API SmallPict.

Arsitektur & Spesifikasi REST API

REST API SmallPict adalah layanan berbasis OpenAPI 3.1 yang memberikan akses langsung ke sistem optimasi gambar terdistribusi, transformasi format, dan CDN edge caching.


🌐 Daftar Base URL

LingkunganAlamat URLKeterangan
Produksihttps://api.smallpict.app/v1Gateway API utama dengan routing Anycast global
Failover Ketersediaan Tinggihttps://api.smolpict.com/v1Gateway sekunder untuk redundansi multi-region
Server Mock Lokalhttp://localhost:8080/v1Lingkungan pengujian dan unit test lokal

🏛️ Endpoint API Utama

Semua permintaan wajib menyertakan header tanda tangan HMAC-SHA256 (lihat Panduan Autentikasi).

1. Optimasi & Konversi Gambar

  • Endpoint: POST /v1/optimize (Alias: POST /v1/convert)
  • Fungsi: Mengirim gambar untuk dikompresi dan ditranskode ke format AVIF, WebP, JPEG, atau PNG.

2. Pengecekan Status Pekerjaan Asinkron

  • Endpoint: GET /v1/optimize/status?job_id={job_id}
  • Fungsi: Memantau proses dan mengambil URL unduhan hasil konversi gambar.

3. Informasi Kuota & Bandwidth

  • Endpoint: GET /v1/quota
  • Fungsi: Mengambil data pemakaian kuota bulanan dan konsumsi bandwidth CDN secara real-time.

4. Pembersihan Cache Edge CDN

  • Endpoint: POST /v1/purge
  • Fungsi: Membersihkan cache gambar di seluruh jaringan edge Cloudflare.