Brand-API

In ANKK wird jeder Public-API-Schlüssel bei der Erstellung automatisch an eine einzelne Marke gebunden. Alle nachfolgenden API-Anfragen erfolgen im Kontext dieser Marke. Sie können die Markendetails abrufen, um die Gültigkeit des Schlüssels und den Zugriffsstatus zu überprüfen.

📌 Endpunkte

Methode	Pfad	Beschreibung	Erforderlicher Scope
`GET`	`/v1/brand`	Details für die an den API-Key gebundene Brand abrufen	`brands:read` oder `*`
`GET`	`/v1/brands`	Die an den Key gebundene Brand, verpackt in einem Listen-Array, abrufen	`brands:read` oder `*`

🔍 Brand-Details abrufen (`GET /v1/brand`)

Überprüfen Sie, mit welcher Brand Ihr spk_... API-Key verknüpft ist.

Anfragebeispiel

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

Antwortbeispiel (`200 OK`)

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

Antwortfelder

Feld	Typ	Beschreibung
`brand_ref`	`string`	Eindeutige Brand-Kennung (ULID-Format)
`name`	`string`	Anzeigename der Brand
`slug`	`string`	Eindeutiger Slug, der in URL-Pfaden verwendet wird
`role`	`string`	Berechtigungsrolle des Key-Ausstellers (`owner`)
`is_locked`	`boolean`	Gibt an, ob die Brand aufgrund von Abrechnungs- oder Richtlinienbeschränkungen gesperrt ist

[!IMPORTANT] Wenn is_locked: true, werden Veröffentlichungs- und Schreibvorgänge mit 423 Locked (brand_locked) blockiert. Überprüfen Sie Ihr Abonnement unter Pläne & Limits oder im Abrechnungs-Leitfaden.

🔗 Verwandte Dokumentation