API Merek

Di ANKK, setiap kunci API Publik secara otomatis terikat ke satu Merek saat pembuatan. Semua permintaan API berikutnya beroperasi dalam konteks merek tersebut. Anda dapat mengambil detail merek untuk memverifikasi validitas kunci dan status akses.

📌 Titik Akhir

Metode	Jalur	Deskripsi	Cakupan yang Diperlukan
`GET`	`/v1/brand`	Mengambil detail untuk merek yang terikat pada kunci API	`brands:read` atau `*`
`GET`	`/v1/brands`	Mengambil merek yang terikat kunci dalam bentuk array daftar	`brands:read` atau `*`

🔍 Ambil Detail Merek (`GET /v1/brand`)

Verifikasi merek mana yang terhubung dengan kunci API spk_... Anda.

Contoh Permintaan

curl -X GET "https://api.ankk.app/v1/brand" \
  -H "Authorization: Bearer spk_live_xxxxxxxx"

Contoh Respons (`200 OK`)

{
  "brand_ref": "brand_01jm8v4k9example",
  "name": "ACME Studio",
  "slug": "acme-studio",
  "role": "owner",
  "is_locked": false
}

Bidang Respons

Bidang	Tipe	Deskripsi
`brand_ref`	`string`	Pengenal merek unik (format ULID)
`name`	`string`	Nama tampilan merek
`slug`	`string`	Slug unik yang digunakan dalam jalur URL
`role`	`string`	Peran izin penerbit kunci (`owner`)
`is_locked`	`boolean`	Menunjukkan apakah merek dikunci karena pembatasan penagihan atau kebijakan

[!IMPORTANT] Jika is_locked: true, operasi penerbitan dan penulisan akan diblokir dengan 423 Locked (brand_locked). Periksa langganan Anda di bawah Paket & Batasan atau Panduan Penagihan.

🔗 Dokumentasi Terkait