Autentifikácia

Všetky API požiadavky na 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 API endpointy sú relatívne k tejto základnej URL.

Autentifikácia API kľúčom

Hlavná metóda autentifikácie je API kľúč odovzdaný v hlavičke X-Api-Key.

Získanie API kľúča

Z dashboardu:

1. Prihláste sa na badges.ninja.
2. V bočnom paneli prejdite na API kľúče.
3. Kliknite na Vytvoriť API kľúč.
4. Skopírujte kľúč (zobrazí sa iba raz).

Z API:

API kľúče možno tiež spravovať cez API pomocou vášho JWT tokenu z autentifikačného toku Cognito. Najjednoduchší prístup nájdete v dashboarde.

Použitie vášho API kľúča

Pridajte hlavičku X-Api-Key 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ú prefix bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Formát požiadavky

• GET požiadavky odovzdávajú parametre ako query stringy
• POST a PUT požiadavky posielajú JSON telo s objektom parameters
• Všetky odpovede vracajú JSON s Content-Type: application/json

Štruktúra POST/PUT požiadavky

{
  "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

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

Limity rýchlosti

API požiadavky podliehajú obmedzeniu rýchlosti. Ak prekročíte limit, dostanete odpoveď 429 Too Many Requests. Počkajte niekoľko sekúnd a skúste to znova.

Verejné endpointy

Niektoré endpointy nevyžadujú autentifikáciu. Sú to verejné overovacie endpointy pod /certify-badge/, ktoré umožňujú komukoľvek overiť osvedčenia odznakov.