브랜드 API
앙크의 Public API 키는 발급 시 특정 **브랜드(Brand)**에 자동으로 귀속됩니다. 따라서 모든 API 요청은 해당 브랜드의 컨텍스트 내에서 실행되며, 브랜드 정보를 직접 조회하여 키의 유효성과 접근 범위를 확인할 수 있습니다.
📌 엔드포인트 목록
섹션 제목: “📌 엔드포인트 목록”| 메서드 | 경로 | 설명 | 필요 스코프 |
|---|---|---|---|
GET | /v1/brand | 현재 API 키에 바인딩된 브랜드 상세 정보 조회 | brands:read 또는 * |
GET | /v1/brands | 호환성을 위한 단일 브랜드 목록 배열 반환 | brands:read 또는 * |
🔍 브랜드 정보 조회 (GET /v1/brand)
섹션 제목: “🔍 브랜드 정보 조회 (GET /v1/brand)”현재 사용 중인 spk_... API 키가 어떤 브랜드에 바인딩되어 있는지 확인합니다.
요청 예시
섹션 제목: “요청 예시”curl -X GET "https://api.ankk.app/v1/brand" \ -H "Authorization: Bearer spk_live_xxxxxxxx"응답 예시 (200 OK)
섹션 제목: “응답 예시 (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 | 브랜드 고유 슬러그 (URL 주소 식별자) |
role | string | API 키 발급자의 권한 역할 (owner) |
is_locked | boolean | 요금제 만료 또는 정책 위반으로 인한 브랜드 잠금 여부 |
[!IMPORTANT]
is_locked: true인 경우 콘텐츠 발행 및 쓰기 작업이423 Locked(brand_locked) 오류로 차단됩니다. 요금제와 제한 또는 결제 관리에서 구독 상태를 확인하세요.