Avtentikacija

Vse API zahteve na badges.ninja zahtevajo avtentikacijo. Ta stran pojasnjuje, kako avtenticirati svoje zahteve.

Osnovni URL

https://api.badges.ninja

Vsi API endpointi so relativni glede na ta osnovni URL.

Avtentikacija z API ključem

Glavna metoda avtentikacije je API ključ, posredovan v glavi X-Api-Key.

Pridobivanje API ključa

Z nadzorne plošče:

1. Prijavite se na badges.ninja.
2. V stranski vrstici pojdite na API ključi.
3. Kliknite Ustvari API ključ.
4. Kopirajte ključ (prikaže se le enkrat).

Iz API:

API ključe je mogoče upravljati tudi prek API z uporabo vašega žetona JWT iz toka avtentikacije Cognito. Najpreprostejši pristop najdete v nadzorni plošči.

Uporaba vašega API ključa

V vsako zahtevo vključite glavo X-Api-Key:

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

Oblika API ključa

Ključi uporabljajo predpono bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Oblika zahteve

• GET zahteve posredujejo parametre kot poizvedbene nize
• POST in PUT zahteve pošiljajo telo JSON z objektom parameters
• Vsi odgovori vračajo JSON s Content-Type: application/json

Struktura zahteve POST/PUT

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

Primer zahteve

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"
    }
  }'

Primer odgovora

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

Omejitve hitrosti

API zahteve so podvržene omejevanju hitrosti. Če presežete omejitev, prejmete odgovor 429 Too Many Requests. Počakajte nekaj sekund in poskusite znova.

Javni endpointi

Nekateri endpointi ne zahtevajo avtentikacije. To so javni endpointi za preverjanje pod /certify-badge/, ki omogočajo komurkoli preveriti spričevala značk.