Autentizace

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

Základní URL

https://api.badges.ninja

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

Autentizace klíčem API

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

Získání klíče API

Z panelu:

1. Přihlaste se na badges.ninja.
2. Přejděte na Klíče API v bočním panelu.
3. Klikněte na Vytvořit klíč API.
4. Zkopírujte klíč (zobrazuje se pouze jednou).

Z API:

Klíče API lze také spravovat přes API pomocí vašeho JWT tokenu z autentizačního toku Cognito. Nejjednodušší přístup je však z panelu.

Použití klíče API

Přiložte hlavičku X-Api-Key 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 klíče API

Klíče používají prefix bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Formát požadavku

• Požadavky GET předávají parametry jako query string
• Požadavky POST a PUT posílají JSON tělo s objektem parameters
• Všechny odpovědi vrací JSON s Content-Type: application/json

Struktura POST/PUT požadavku

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

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

Omezení rychlosti

Požadavky API podléhají omezení rychlosti. Pokud limit překročíte, dostanete odpověď 429 Too Many Requests. Počkejte pár sekund a opakujte.

Veřejné endpointy

Některé endpointy nevyžadují autentizaci. Jedná se o veřejné ověřovací endpointy pod /certify-badge/, které umožňují komukoli ověřit osvědčení odznaků.