Badges API

Spravujte šablóny odznakov — osvedčenia, ktoré udeľujete príjemcom.

Všetky endpointy vyžadujú autentifikáciu cez hlavičku X-Api-Key. Pozri Autentifikácia.

Vytvoriť odznak

Vytvorte nový odznak pod overeným vydavateľom.

POST /badges

Parametre

Parameter	Typ	Povinné	Popis
name	string	Áno	Titul odznaku
description	string	Áno	Čo odznak reprezentuje
criteria	string	Áno	Čo musel príjemca urobiť, aby získal tento odznak
image	string	Áno	Obrázok kódovaný v Base64 (PNG alebo JPG)
issuerId	string	Áno	ID overeného vydavateľa

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

Odpoveď

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

Poznámky

• Vydavateľ musí byť overený pred vytvorením odznakov.
• Obrázok je nahraný do IPFS pre trvalé uloženie.

---

Zobraziť odznaky

Získajte všetky odznaky, ktoré ste vytvorili.

GET /badges

Príklad

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

Odpoveď

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

---

Aktualizovať odznak

Aktualizujte existujúci odznak. Zmenia sa iba polia, ktoré poskytnete.

PUT /badges/{badgeId}

Parametre

Parameter	Typ	Povinné	Popis
badgeId	string	Áno	ID odznaku (parameter cesty)
name	string	Nie	Nový titul odznaku
description	string	Nie	Nový popis
criteria	string	Nie	Nové kritériá
image	string	Nie	Nový obrázok kódovaný v Base64

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

Odpoveď

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

---

Aktualizovať text zdieľania

Nastavte vlastný text zobrazený, keď príjemcovia zdieľajú tento odznak na sociálnych médiách.

PUT /badges/{badgeId}/share-text

Parametre

Parameter	Typ	Povinné	Popis
badgeId	string	Áno	ID odznaku (parameter cesty)
text	string	Áno	Text zdieľania (žiadne HTML nepovolené)

Prí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:"
    }
  }'

Odpoveď

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

---

Odstrániť odznak

Odstráňte odznak. Odznak nesmie mať žiadne udelenia.

DELETE /badges/{badgeId}

Príklad

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

Odpoveď

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

Chyby

• 400 — odznak má udelenia a nemožno ho odstrániť
• 404 — odznak sa nenašiel