Skip to content

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ů, udělování a správy z vlastních aplikací.

Klíče API — prázdný stav

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ář:

Vytvořit klíč — formulář názvu

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

Nově vytvořený klíč zobrazený jednou

  1. 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:

Seznam klíčů zobrazující maskovaný prefix

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:

bash
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ánLimit klíčů API
Free1
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í.

Potvrzení smazání klíče — odvolání je okamžité

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

badges.ninja Documentation