Skip to content

API kľúče

API kľúče vám umožňujú programovo pristupovať k REST API badges.ninja. Použite ich na automatizáciu vytvárania, udeľovania a správy odznakov z vlastných aplikácií.

API kľúče — prázdny stav

Vytvorenie API kľúča

  1. Otvorte v bočnom paneli stránku API kľúče.
  2. Kliknite na Vytvoriť API kľúč. Otvorí sa vstavaný formulár:

Vytvorenie kľúča — formulár názvu

  1. Pomenujte kľúč a kliknite na Vytvoriť. Celý kľúč sa zobrazí iba raz v zelenom paneli:

Práve vytvorený kľúč zobrazený raz

  1. Kľúč si okamžite skopírujte — zobrazí sa len raz. Ak ho stratíte, budete musieť vytvoriť nový. Po zatvorení panela sa uchová iba jeho prefix:

Zoznam kľúčov so zamaskovaným prefixom

Formát kľúča

API kľúče používajú prefix bws_ nasledovaný 32-znakovým hex reťazcom:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Použitie API kľúčov v požiadavkách

Pridajte API kľúč do hlavičky X-Api-Key každej API požiadavky:

bash
curl -X GET https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here"

Úplné podrobnosti o autentifikácii API nájdete na stránke Autentifikácia.

Limity kľúčov podľa plánu

Počet API kľúčov, ktoré môžete vytvoriť, závisí od vášho plánu:

PlánLimit API kľúčov
Free1
Starter ($9/mes)5
Pro ($29/mes)20

Odstránenie kľúča

  1. Otvorte stránku API kľúče.
  2. Vyhľadajte kľúč, ktorý chcete odstrániť.
  3. Kliknite na Odstrániť.
  4. Potvrďte odstránenie.

Potvrdenie odstránenia kľúča — odvolanie je okamžité

Po odstránení kľúč okamžite prestane fungovať. Akékoľvek aplikácie používajúce tento kľúč dostanú chyby autentifikácie.

badges.ninja Documentation