Autentikavimas

Visos API užklausos į badges.ninja reikalauja autentikavimo. Šis puslapis paaiškina, kaip autentikuoti savo užklausas.

Bazinis URL

https://api.badges.ninja

Visi API galutiniai taškai yra sąlyginiai pagal šį bazinį URL.

API raktų autentikavimas

Pagrindinis autentikavimo metodas yra API raktas, perduodamas antraštėje X-Api-Key.

API rakto gavimas

Iš 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ą).

Iš API:

API raktus taip pat galima valdyti per API naudojant savo JWT žetoną iš Cognito autentikavimo srauto. Paprasčiausiam metodui žr. skydelį.

API rakto naudojimas

Įtraukite antraštę X-Api-Key į kiekvieną užklausą:

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

API rakto formatas

Raktai naudoja bws_ prefiksą:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Užklausos formatas

• GET užklausos perduoda parametrus kaip užklausos eilutes
• POST ir PUT užklausos siunčia JSON kūną 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

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

Greičio apribojimai

API užklausoms taikomi greičio apribojimai. Jei viršijate limitą, gaunate atsakymą 429 Too Many Requests. Palaukite kelias sekundes ir bandykite dar kartą.

Vieši galutiniai taškai

Kai kurie galutiniai taškai nereikalauja autentikavimo. Tai yra viešosios patikros galutiniai taškai po /certify-badge/, leidžiantys bet kam patikrinti ženklelių pažymėjimus.