API Thương hiệu

Trong ANKK, mỗi khóa Public API được tự động liên kết với một Thương hiệu (Brand) duy nhất khi được tạo. Tất cả các yêu cầu API tiếp theo đều hoạt động trong ngữ cảnh của thương hiệu đó. Bạn có thể lấy thông tin chi tiết thương hiệu để xác minh tính hợp lệ của khóa và trạng thái truy cập.

📌 Điểm cuối

Phương thức	Đường dẫn	Mô tả	Scope yêu cầu
`GET`	`/v1/brand`	Lấy chi tiết cho thương hiệu được liên kết với khóa API	`brands:read` hoặc `*`
`GET`	`/v1/brands`	Lấy thương hiệu được liên kết với khóa được bọc trong một mảng danh sách	`brands:read` hoặc `*`

🔍 Lấy chi tiết thương hiệu (`GET /v1/brand`)

Xác minh xem khóa API spk_... của bạn được đính kèm với thương hiệu nào.

Ví dụ yêu cầu

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

Ví dụ phản hồi (`200 OK`)

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

Các trường phản hồi

Trường	Loại	Mô tả
`brand_ref`	`string`	Mã định danh thương hiệu duy nhất (định dạng ULID)
`name`	`string`	Tên hiển thị của thương hiệu
`slug`	`string`	Slug duy nhất được sử dụng trong các đường dẫn URL
`role`	`string`	Vai trò quyền của người cấp khóa (`owner`)
`is_locked`	`boolean`	Cho biết liệu thương hiệu có bị khóa do các hạn chế về thanh toán hoặc chính sách hay không

[!IMPORTANT] Nếu is_locked: true, các hoạt động xuất bản và ghi sẽ bị chặn với lỗi 423 Locked (brand_locked). Hãy kiểm tra đăng ký của bạn trong phần Các gói & Giới hạn hoặc Hướng dẫn thanh toán.

🔗 Tài liệu liên quan