Autentikavimas

Visoms API užklausoms į badges.ninja reikalingas autentikavimas. Šiame puslapyje paaiškinama, kaip autentikuoti savo užklausas.

Bazinis URL

https://api.badges.ninja

Visi API galutiniai taškai nurodomi šio bazinio URL atžvilgiu.

Autentikavimas API raktu

Pagrindinis autentikavimo būdas – API raktas, perduodamas antraštėje X-Api-Key.

API rakto gavimas

Iš informacijos skydelio:

1. Prisijunkite adresu badges.ninja.
2. Šoninėje juostoje eikite į API raktai.
3. Spustelėkite Sukurti API raktą.
4. Nukopijuokite raktą (jis rodomas tik vieną kartą).

Per API:

API raktus taip pat galima valdyti per API, naudojant JWT žetoną iš Cognito autentikavimo srauto. Paprasčiausias būdas – informacijos skydelis.

API rakto naudojimas

Kiekvienoje užklausoje pateikite antraštę X-Api-Key:

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

API rakto formatas

Raktai naudoja priešdėlį bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Užklausos formatas

• GET užklausos perduoda parametrus užklausos eilutėje
• POST ir PUT užklausos siunčia JSON turinį su objektu parameters
• Visi atsakymai grąžina JSON su Content-Type: application/json

POST/PUT užklausos struktūra

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

Užklausos pavyzdys

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

Atsakymo pavyzdys

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

Vieši galutiniai taškai

Kai kuriems galutiniams taškams autentikavimas nereikalingas. Tai vieši patikrinimo galutiniai taškai, esantys po /certify-badge/, leidžiantys bet kam patikrinti skaitmeninių ženklelių pažymėjimus.