ब्रांड API

ANKK में, प्रत्येक पब्लिक API कुंजी निर्माण के समय स्वचालित रूप से एक ब्रांड (Brand) से जुड़ जाती है। बाद के सभी API अनुरोध उसी ब्रांड के संदर्भ में काम करते हैं। आप कुंजी की वैधता और एक्सेस स्थिति को सत्यापित करने के लिए ब्रांड विवरण प्राप्त कर सकते हैं।

📌 एंडपॉइंट्स (Endpoints)

विधि (Method)	पाथ (Path)	विवरण (Description)	आवश्यक स्कोप (Required Scope)
`GET`	`/v1/brand`	API कुंजी से जुड़े ब्रांड के विवरण प्राप्त करें	`brands:read` या `*`
`GET`	`/v1/brands`	कुंजी से जुड़े ब्रांड को एक सूची सरणी (list array) में प्राप्त करें	`brands:read` या `*`

🔍 ब्रांड विवरण प्राप्त करें (`GET /v1/brand`)

सत्यापित करें कि आपकी spk_... API कुंजी किस ब्रांड से जुड़ी है।

अनुरोध उदाहरण (Request Example)

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

प्रतिक्रिया उदाहरण (Response Example) (`200 OK`)

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

प्रतिक्रिया फ़ील्ड (Response Fields)

फ़ील्ड	प्रकार	विवरण
`brand_ref`	`string`	विशिष्ट ब्रांड पहचानकर्ता (ULID प्रारूप)
`name`	`string`	ब्रांड का डिस्प्ले नाम
`slug`	`string`	URL पाथ में उपयोग किया जाने वाला अद्वितीय स्लग
`role`	`string`	कुंजी जारीकर्ता की अनुमति भूमिका (`owner`)
`is_locked`	`boolean`	इंगित करता है कि बिलिंग या नीतिगत प्रतिबंधों के कारण ब्रांड लॉक है या नहीं

[!IMPORTANT] यदि is_locked: true है, तो प्रकाशन और राइट (write) संचालन 423 Locked (brand_locked) के साथ ब्लॉक कर दिए जाएंगे। प्लान और सीमाएं या बिलिंग गाइड के तहत अपनी सदस्यता की जांच करें।

🔗 संबंधित दस्तावेज़