Klíče API

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

Vytvoření klíče API

1. Otevřete v bočním panelu stránku Klíče API.
2. Klikněte na Vytvořit klíč API. Otevře se inline formulář:

3. Přidělte klíči název a klikněte na Vytvořit. Plný klíč se zobrazí jednou na zeleném banneru:

4. Zkopírujte klíč okamžitě — zobrazí se pouze jednou. Pokud jej ztratíte, budete muset vytvořit nový. Po zavření banneru se ukládá pouze prefix:

Oprávnění přístupu

Při vytváření klíče jej můžete nastavit jako pouze pro čtení nebo ponechat s plným přístupem:

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

Používejte klíč pouze pro čtení pro integrace, které potřebují vaše data pouze číst (reportování, dashboardy, zálohy), aby uniklý klíč nemohl nic změnit. Zaškrtněte Read-only key ve formuláři vytvoření; klíče pouze pro čtení zobrazují v seznamu odznak Read-only. Klíče vytvořené před existencí oprávnění si ponechávají plný přístup.

Formát klíče

Klíče API používají prefix bws_ následovaný 32znakovým řetězcem v hex:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

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

Přiložte klíč API do hlavičky X-Api-Key každého požadavku:

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

Podrobnosti o autentizaci API najdete na stránce Autentizace.

Limity klíčů podle plánu

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

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

Smazání klíče

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

Po smazání klíč okamžitě přestane fungovat. Všechny aplikace používající tento klíč obdrží chyby autentizace.