API แบรนด์

คีย์ Public API แต่ละชุดของ ANKK จะผูกกับ แบรนด์ เดียวโดยอัตโนมัติเมื่อสร้างขึ้น คำขอ API ทั้งหมดจะทำงานภายใต้บริบทของแบรนด์นั้น คุณสามารถดึงรายละเอียดแบรนด์เพื่อตรวจสอบคีย์และสถานะการเข้าถึงได้

📌 Endpoint

เมธอด	พาธ	คำอธิบาย	ขอบเขตสิทธิ์ที่จำเป็น
`GET`	`/v1/brand`	ดึงรายละเอียดของแบรนด์ที่ผูกกับคีย์ API	`brands:read` หรือ `*`
`GET`	`/v1/brands`	ดึงข้อมูลแบรนด์ที่ผูกกับคีย์เป็นอาร์เรย์	`brands:read` หรือ `*`

🔍 ดึงรายละเอียดแบรนด์ (`GET /v1/brand`)

ตรวจสอบว่าคีย์ API spk_... ของคุณผูกกับแบรนด์ใด

ตัวอย่างคำขอ

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

ตัวอย่างการตอบกลับ (`200 OK`)

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

ฟิลด์ในการตอบกลับ

ฟิลด์	ประเภท	คำอธิบาย
`brand_ref`	`string`	รหัสเฉพาะของแบรนด์ (รูปแบบ ULID)
`name`	`string`	ชื่อที่แสดงของแบรนด์
`slug`	`string`	Slug เฉพาะที่ใช้ในพาธ URL
`role`	`string`	บทบาทของผู้ออกคีย์ (`owner`)
`is_locked`	`boolean`	ระบุว่าแบรนด์ถูกล็อกเนื่องจากการชำระเงินหรือข้อจำกัดด้านนโยบายหรือไม่

[!IMPORTANT] หาก is_locked: true การดำเนินการเผยแพร่และเขียนข้อมูลจะถูกบล็อกด้วยข้อผิดพลาด 423 Locked (brand_locked) กรุณาตรวจสอบการสมัครสมาชิกของคุณที่ แผนบริการและขีดจำกัด หรือ คู่มือการชำระเงิน

🔗 เอกสารที่เกี่ยวข้อง