API odznaků

Spravujte šablony odznaků — osvědčení, která udělujete příjemcům.

Všechny endpointy vyžadují autentizaci přes hlavičku X-Api-Key. Viz Autentizace.

Vytvořit odznak

Vytvořte nový odznak pod ověřeným vydavatelem.

POST /badges

Parametry

Parametr	Typ	Povinný	Popis
name	string	Ano	Titul odznaku
description	string	Ano	Co odznak reprezentuje
criteria	string	Ano	Co příjemce udělal, aby tento odznak získal
image	string	Ano	Obrázek zakódovaný v Base64 (PNG nebo JPG)
issuerId	string	Ano	ID ověřeného vydavatele

Příklad

curl -X POST https://api.badges.ninja/badges \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "JavaScript Fundamentals",
      "description": "Demonstrates proficiency in core JavaScript concepts",
      "criteria": "Completed the JavaScript Fundamentals course with a score of 80% or higher",
      "image": "data:image/png;base64,iVBORw0KGgo...",
      "issuerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  }'

Odpověď

{
  "statusCode": 200,
  "info": {
    "badgeId": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-f5a6-7890-bcde-f12345678901"
  }
}

Poznámky

• Vydavatel musí být před vytvořením odznaku ověřen.
• Obrázek se nahrává do IPFS pro trvalé uložení.

---

Seznam odznaků

Načtěte všechny odznaky, které jste vytvořili.

GET /badges

Příklad

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

Odpověď

{
  "statusCode": 200,
  "info": {
    "badges": [
      {
        "id": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
        "name": "JavaScript Fundamentals",
        "description": "Demonstrates proficiency in core JavaScript concepts",
        "criteria": { "narrative": "Completed the JavaScript Fundamentals course..." },
        "image": "https://ipfs.ninja/ipfs/Qm...",
        "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
        "timestamp": "2025-01-15T10:30:00.000Z"
      }
    ]
  }
}

---

Aktualizovat odznak

Aktualizujte existující odznak. Změní se pouze pole, která zadáte.

PUT /badges/{badgeId}

Parametry

Parametr	Typ	Povinný	Popis
badgeId	string	Ano	ID odznaku (parametr v cestě)
name	string	Ne	Nový titul odznaku
description	string	Ne	Nový popis
criteria	string	Ne	Nová kritéria
image	string	Ne	Nový obrázek zakódovaný v Base64

Příklad

curl -X PUT https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901 \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "badgeId": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
      "name": "JavaScript Fundamentals v2",
      "description": "Updated description for the JS badge"
    }
  }'

Odpověď

{
  "statusCode": 200,
  "info": {
    "badgeId": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
    "updated": true
  }
}

---

Aktualizovat text sdílení

Nastavte vlastní text zobrazovaný při sdílení tohoto odznaku na sociálních sítích.

PUT /badges/{badgeId}/share-text

Parametry

Parametr	Typ	Povinný	Popis
badgeId	string	Ano	ID odznaku (parametr v cestě)
text	string	Ano	Text sdílení (HTML není povoleno)

Příklad

curl -X PUT https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901/share-text \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "badgeId": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
      "text": "I just earned the JavaScript Fundamentals badge! Check it out:"
    }
  }'

Odpověď

{
  "statusCode": 200,
  "info": {
    "updated": true
  }
}

---

Smazat odznak

Smažte odznak. Odznak nesmí mít žádná udělení.

DELETE /badges/{badgeId}

Příklad

curl -X DELETE https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901 \
  -H "X-Api-Key: bws_your_api_key_here"

Odpověď

{
  "statusCode": 200,
  "info": {
    "deleted": true
  }
}

Chyby

• 400 — odznak má udělení a nelze jej smazat
• 404 — odznak nenalezen