Hitelesítés

A badges.ninja minden API-kéréséhez hitelesítés szükséges. Ez az oldal bemutatja, hogyan hitelesítheted a kéréseidet.

Alap URL

https://api.badges.ninja

Minden API-végpont ehhez az alap URL-hez képest értendő.

Hitelesítés API-kulccsal

Az elsődleges hitelesítési módszer az X-Api-Key fejlécben átadott API-kulcs.

API-kulcs megszerzése

Az irányítópultról:

1. Jelentkezz be a badges.ninja-n.
2. Az oldalsávban nyisd meg az API Keys menüpontot.
3. Kattints a Create API Key gombra.
4. Másold ki a kulcsot (csak egyszer jelenik meg).

Az API-n keresztül:

Az API-kulcsok az API-n keresztül is kezelhetők a Cognito hitelesítési folyamatból kapott JWT tokenneddel. A legegyszerűbb megoldásért használd az irányítópultot.

Az API-kulcs használata

Minden kérésben add meg az X-Api-Key fejlécet:

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

Az API-kulcs formátuma

A kulcsok bws_ előtagot használnak:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Kérésformátum

• A GET kérések a paramétereket lekérdezési karakterláncként (query string) adják át
• A POST és PUT kérések JSON törzset küldenek egy parameters objektummal
• Minden válasz JSON-t ad vissza Content-Type: application/json fejléccel

POST/PUT kérés felépítése

{
  "parameters": {
    "name": "My Badge",
    "description": "A sample badge"
  }
}

Példa kérés

curl -X POST https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "My Organization",
      "url": "https://example.com",
      "email": "admin@example.com"
    }
  }'

Példa válasz

{
  "issuerId": "https://api.badges.ninja/certify-badge/issuer/abc123-def456"
}

Nyilvános végpontok

Egyes végpontokhoz nincs szükség hitelesítésre. Ezek a /certify-badge/ alatti nyilvános ellenőrzési végpontok, amelyek bárkinek lehetővé teszik a jelvény-hitelesítő adatok ellenőrzését.