API-kulcsok

Az API-kulcsokkal programozottan érheted el a badges.ninja REST API-t. Használd őket a jelvények létrehozásának, kiállításának és kezelésének automatizálására a saját alkalmazásaidból.

API-kulcs létrehozása

1. Nyisd meg az API Keys oldalt az oldalsávról.
2. Kattints a Create API Key gombra. Egy beágyazott űrlap nyílik meg:

3. Adj nevet a kulcsnak, majd kattints a Create gombra. A teljes kulcs csak egyszer jelenik meg egy zöld sávban:

4. Másold ki azonnal a kulcsot — a teljes kulcs csak egyszer látható. Ha elveszted, újat kell létrehoznod. A sáv bezárása után az irányítópult már csak a kulcs előtagját mutatja (pl. bws_a1b2c3d4...); a teljes kulcs a szerveren marad tárolva a kérések hitelesítéséhez:

Minden sor megmutatja a kulcs létrehozásának idejét, használat után pedig egy last used időbélyeget is, így könnyen kiszúrhatod az elavult kulcsokat.

Hozzáférési hatókörök

Kulcs létrehozásakor megadhatod, hogy csak olvasható legyen, vagy meghagyhatod teljes hozzáférésűnek:

Hatókör	Engedélyezett
Teljes hozzáférés (alapértelmezett)	Olvasás és írás — adatok listázása, valamint létrehozás, kiállítás, módosítás vagy törlés.
Csak olvasható	Kizárólag biztonságos GET kérések. Minden módosító kérést (POST, PUT, PATCH, DELETE) 403 Forbidden válasszal utasít el a rendszer.

Használj csak olvasható kulcsot azokhoz az integrációkhoz, amelyeknek elég az adataid olvasása (riportok, irányítópultok, mentések), így egy kiszivárgott kulcs sem módosíthat semmit. Az űrlapon jelöld be a Read-only key négyzetet; a csak olvasható kulcsok a listában Read-only címkét kapnak. A hatókörök bevezetése előtt létrehozott kulcsok teljes hozzáférésűek maradnak.

Kulcsformátum

Az API-kulcsok a bws_ előtaggal kezdődnek, amelyet egy 32 karakteres hexadecimális karakterlánc követ:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

API-kulcsok használata a kérésekben

Minden API-kérés X-Api-Key fejlécében add meg 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észleteiért lásd a Hitelesítés oldalt.

Kulcskorlátok csomagonként

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

Csomag	API-kulcsok korlátja
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Kulcs lejárata

Minden API-kulcs a létrehozása után egy évvel lejár. A lejárt kulcs már nem hitelesít kéréseket, pontosan úgy, mintha törölték volna. Hozz létre új kulcsot, mielőtt a régi lejár, hogy elkerüld a fennakadást.

Kulcs törlése

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

A törlés után a kulcs azonnal működésképtelenné válik. Az azt használó alkalmazások hitelesítési hibát kapnak.