Autentizace

Všechny požadavky na API badges.ninja vyžadují autentizaci. Tato stránka vysvětluje, jak své požadavky autentizovat.

Základní URL

https://api.badges.ninja

Všechny endpointy API jsou relativní k této základní URL.

Autentizace pomocí API klíče

Primární metodou autentizace je API klíč předávaný v hlavičce X-Api-Key.

Získání API klíče

Z dashboardu:

1. Přihlaste se na badges.ninja.
2. V postranním panelu přejděte do sekce API klíče.
3. Klikněte na Vytvořit API klíč.
4. Zkopírujte klíč (zobrazí se pouze jednou).

Z API:

API klíče lze spravovat i přes API pomocí vašeho JWT tokenu z autentizačního toku Cognito. Nejjednodušší cestou je dashboard.

Použití API klíče

Hlavičku X-Api-Key přidejte do každého požadavku:

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

Formát API klíče

Klíče používají předponu bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Formát požadavku

• Požadavky GET předávají parametry jako řetězec dotazu (query string)
• Požadavky POST a PUT posílají tělo JSON s objektem parameters
• Všechny odpovědi vracejí JSON s hlavičkou Content-Type: application/json

Struktura požadavku POST/PUT

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

Příklad požadavku

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

Příklad odpovědi

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

Veřejné endpointy

Některé endpointy autentizaci nevyžadují. Jde o veřejné endpointy pro ověření pod /certify-badge/, které umožňují komukoli ověřit pověření odznaků.