API klíče

API klíče vám umožňují programový přístup k REST API badges.ninja. Použijte je k automatizaci vytváření, vydávání a správy odznaků z vašich vlastních aplikací.

Vytvoření API klíče

1. Otevřete v bočním panelu stránku API Keys.
2. Klikněte na Create API Key. Otevře se vložený formulář:

3. Zadejte klíči název a klikněte na Create. Celý klíč se zobrazí jen jednou na zeleném banneru:

4. Klíč okamžitě zkopírujte — celý klíč se zobrazí pouze jednou. Pokud jej ztratíte, budete muset vytvořit nový. Po zavření banneru zobrazuje dashboard už jen prefix klíče (např. bws_a1b2c3d4...); celý klíč zůstává uložen na straně serveru, aby mohl ověřovat vaše požadavky:

Každý řádek také zobrazuje, kdy byl klíč vytvořen, a po prvním použití i časové razítko posledního použití, abyste snadno poznali nepoužívané klíče.

Rozsahy přístupu

Při vytvoření klíče jej můžete nastavit jako jen pro čtení, nebo ponechat plný přístup:

Rozsah	Umožňuje
Plný přístup (výchozí)	Čtení i zápis — výpis dat a vytváření, vydávání, úpravy nebo mazání.
Jen pro čtení	Pouze bezpečné požadavky GET. Jakýkoli požadavek, který data mění (POST, PUT, PATCH, DELETE), je zamítnut s chybou 403 Forbidden.

Klíč pouze pro čtení použijte pro integrace, které potřebují data jen číst (reporting, dashboardy, zálohy), aby případný únik klíče nemohl nic změnit. Ve formuláři pro vytvoření zaškrtněte Read-only key; klíče pouze pro čtení mají v seznamu štítek Read-only. Klíče vytvořené před zavedením rozsahů si ponechávají plný přístup.

Formát klíče

API klíče používají prefix bws_ následovaný 32znakovým hexadecimálním řetězcem:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Použití API klíčů v požadavcích

Zahrňte API klíč do hlavičky X-Api-Key každého požadavku na API:

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

Úplné podrobnosti o autentizaci API najdete na stránce Autentizace.

Limity klíčů podle plánu

Počet API klíčů, které můžete vytvořit, závisí na vašem plánu:

Plán	Limit API klíčů
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Platnost klíče

Každý API klíč vyprší jeden rok po vytvoření. Jakmile klíč vyprší, přestane ověřovat požadavky, stejně jako by byl smazán. Nový klíč vytvořte dříve, než platnost starého skončí, abyste předešli výpadku.

Smazání klíče

1. Otevřete stránku API Keys.
2. Najděte klíč, který chcete smazat.
3. Klikněte na Delete.
4. Potvrďte smazání.

Po smazání klíč okamžitě přestane fungovat. Všechny aplikace, které tento klíč používají, budou dostávat chyby autentizace.