Autentifikácia

Všetky požiadavky na API badges.ninja vyžadujú autentifikáciu. Táto stránka vysvetľuje, ako autentifikovať vaše požiadavky.

Základná URL

https://api.badges.ninja

Všetky endpointy API sú relatívne k tejto základnej URL.

Autentifikácia pomocou API kľúča

Primárnou metódou autentifikácie je API kľúč odovzdávaný v hlavičke X-Api-Key.

Získanie API kľúča

Z dashboardu:

1. Prihláste sa na badges.ninja.
2. Prejdite do sekcie API Keys v bočnom paneli.
3. Kliknite na Create API Key.
4. Skopírujte kľúč (zobrazí sa iba raz).

Cez API:

API kľúče je možné spravovať aj cez API pomocou vášho tokenu JWT z autentifikačného toku Cognito. Najjednoduchší spôsob je dashboard.

Používanie API kľúča

Hlavičku X-Api-Key zahrňte do každej požiadavky:

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

Formát API kľúča

Kľúče používajú predponu bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Formát požiadavky

• Požiadavky GET odovzdávajú parametre ako reťazec dopytu (query string)
• Požiadavky POST a PUT posielajú telo vo formáte JSON s objektom parameters
• Všetky odpovede vracajú JSON s Content-Type: application/json

Štruktúra požiadavky POST/PUT

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

Príklad požiadavky

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

Príklad odpovede

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

Verejné endpointy

Niektoré endpointy nevyžadujú autentifikáciu. Ide o verejné endpointy na overenie pod /certify-badge/, ktoré každému umožňujú overiť osvedčenia odznakov.