API-kulcsok

Az API-kulcsokkal programozott módon érheted el a badges.ninja REST API-ját. Saját alkalmazásaidból így automatizálhatod a jelvények létrehozását, kiadását és kezelését.

API-kulcs létrehozása

1. Nyisd meg az oldalsávból az API-kulcsok oldalt.
2. Kattints az API-kulcs létrehozása gombra. Megnyílik egy soron belüli űrlap:

3. Adj nevet a kulcsnak, és kattints a Létrehozás gombra. A teljes kulcsot egyszer mutatjuk meg egy zöld sávban:

4. A kulcsot azonnal másold ki — csak egyszer jelenik meg. Ha elveszíted, újat kell létrehoznod. Miután bezárod a sávot, csak az előtagot tároljuk:

Kulcsformátum

Az API-kulcsok a bws_ előtagot, majd egy 32 karakteres hexadecimális karaktersort használnak:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

API-kulcsok használata kérésekben

Minden API-kérés X-Api-Key fejlécébe illeszd be az API-kulcsot:

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

Az API-hitelesítés részleteit lásd a Hitelesítés oldalon.

Kulcskorlátok csomagonként

A létrehozható API-kulcsok száma a csomagtól függ:

Csomag	API-kulcs korlát
Free	1
Starter ($9/hó)	5
Pro ($29/hó)	20

Kulcs törlése

1. Nyisd meg az API-kulcsok oldalt.
2. Keresd meg a törölni kívánt kulcsot.
3. Kattints a Törlés gombra.
4. Erősítsd meg a törlést.

A törlés után a kulcs azonnal használhatatlan lesz. Az adott kulcsot használó alkalmazások hitelesítési hibát kapnak.