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, vydávania a správy odznakov z vašich vlastných aplikácií.

Vytvorenie API kľúča

1. Otvorte v bočnom paneli stránku API Keys.
2. Kliknite na Create API Key. Otvorí sa vložený formulár:

3. Kľúču zadajte názov a kliknite na Create. Úplný kľúč sa zobrazí jedenkrát na zelenom banneri:

4. Kľúč okamžite skopírujte — úplný kľúč sa zobrazí iba raz. Ak ho stratíte, budete musieť vytvoriť nový. Po zatvorení bannera sa na paneli zobrazuje už iba prefix kľúča (napr. bws_a1b2c3d4...); úplný kľúč zostáva uložený na serveri na overovanie vašich požiadaviek:

Každý riadok zobrazuje aj čas vytvorenia kľúča a po jeho použití časovú značku last used, aby ste ľahko odhalili nepoužívané kľúče.

Rozsahy prístupu

Pri vytváraní kľúča ho môžete nastaviť len na čítanie alebo ho ponechať s plným prístupom:

Rozsah	Umožňuje
Plný prístup (predvolené)	Čítanie aj zápis — zobrazenie údajov a vytváranie, vydávanie, aktualizáciu či mazanie.
Len na čítanie	Iba bezpečné požiadavky GET. Každá požiadavka, ktorá mení údaje (POST, PUT, PATCH, DELETE), je zamietnutá s chybou 403 Forbidden.

Kľúč len na čítanie použite pre integrácie, ktoré potrebujú iba čítať vaše údaje (reporty, dashboardy, zálohy), aby uniknutý kľúč nemohol nič zmeniť. Vo formulári na vytvorenie zaškrtnite Read-only key; kľúče len na čítanie majú v zozname odznak Read-only. Kľúče vytvorené pred zavedením rozsahov si ponechávajú plný prístup.

Formát kľúča

API kľúče používajú prefix bws_, za ktorým nasleduje 32-znakový hexadecimálny reťazec:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

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

API kľúč uveďte v hlavičke X-Api-Key pri každej požiadavke na API:

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án	Limit API kľúčov
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Platnosť kľúča

Každý API kľúč expiruje rok po vytvorení. Po expirácii kľúč prestane overovať požiadavky, rovnako ako keby bol odstránený. Nový kľúč vytvorte skôr, než platnosť starého skončí, aby ste predišli výpadku.

Odstránenie kľúča

1. Otvorte stránku API Keys.
2. Nájdite kľúč, ktorý chcete odstrániť.
3. Kliknite na Delete.
4. Potvrďte odstránenie.

Po odstránení kľúč okamžite prestane fungovať. Všetky aplikácie, ktoré tento kľúč používajú, budú dostávať chyby autentifikácie.