Preverjanje pristnosti

Vse zahteve API-ja za badges.ninja zahtevajo preverjanje pristnosti. Ta stran pojasnjuje, kako preveriti pristnost svojih zahtev.

Osnovni URL

https://api.badges.ninja

Vse končne točke API-ja so relativne glede na ta osnovni URL.

Preverjanje pristnosti s ključem API

Glavni način preverjanja pristnosti je ključ API, posredovan v glavi X-Api-Key.

Pridobitev ključa API

Z nadzorne plošče:

1. Prijavite se na badges.ninja.
2. V stranski vrstici odprite API Keys.
3. Kliknite Create API Key.
4. Kopirajte ključ (prikazan je samo enkrat).

Prek API-ja:

Ključe API je mogoče upravljati tudi prek API-ja z uporabo vašega žetona JWT iz poteka preverjanja pristnosti Cognito. Najenostavnejši pristop je nadzorna plošča.

Uporaba ključa API

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 ključa API

Ključi imajo predpono bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Oblika zahteve

• Zahteve GET posredujejo parametre kot poizvedbene nize
• Zahteve POST in PUT pošiljajo telo JSON z objektom parameters
• Vsi odgovori vračajo JSON z 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

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

Javne končne točke

Nekatere končne točke ne zahtevajo preverjanja pristnosti. To so javne končne točke za preverjanje pod /certify-badge/, ki vsakomur omogočajo preverjanje poverilnic značk.