Hitelesítés

A badges.ninja minden API-kérése hitelesítést igényel. Ez az oldal ismerteti, hogyan kell a kéréseket hitelesíteni.

Alap-URL

https://api.badges.ninja

Minden API-végpont ehhez az alap-URL-hez relatív.

Hitelesítés API-kulccsal

Az elsődleges hitelesítési módszer egy API-kulcs, amelyet az X-Api-Key fejlécben adsz meg.

API-kulcs beszerzése

Az irányítópultról:

1. Jelentkezz be a badges.ninja oldalon.
2. Az oldalsávban nyisd meg az API-kulcsok oldalt.
3. Kattints az API-kulcs létrehozása 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 származó JWT-tokennel. A legegyszerűbb útvonal az irányítópult.

Az API-kulcs használata

Minden kéréshez add hozzá 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 a bws_ előtagot használják:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

A kérés formátuma

• A GET kérések a paramétereket query stringként adják át
• A POST és PUT kérések parameters objektummal rendelkező JSON törzset küldenek
• Minden válasz JSON-t ad vissza Content-Type: application/json fejléccel

POST/PUT kérések 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

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

Kéréskorlátok

Az API-kérésekre sebességkorlátozás vonatkozik. Ha túlléped a limitet, 429 Too Many Requests választ kapsz. Várj néhány másodpercet, majd próbáld újra.

Nyilvános végpontok

Néhány végpont nem igényel hitelesítést. Ezek a /certify-badge/ alatti nyilvános ellenőrző végpontok, amelyek bárki számára lehetővé teszik a jelvényhitelesítést.