Badges API

Upravljajte predloge značk — spričevala, ki jih podeljujete prejemnikom.

Vsi endpointi zahtevajo avtentikacijo prek glave X-Api-Key. Glej Avtentikacija.

Ustvari značko

Ustvarite novo značko pod preverjenim izdajateljem.

POST /badges

Parametri

Parameter	Tip	Obvezno	Opis
name	string	Da	Naslov značke
description	string	Da	Kaj značka predstavlja
criteria	string	Da	Kaj je prejemnik storil, da je pridobil to značko
image	string	Da	Slika, kodirana v Base64 (PNG ali JPG)
issuerId	string	Da	ID preverjenega izdajatelja

Primer

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

Odgovor

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

Opombe

• Izdajatelj mora biti preveren pred ustvarjanjem značk.
• Slika je naložena v IPFS za trajno shrambo.

---

Naštej značke

Pridobite vse značke, ki ste jih ustvarili.

GET /badges

Primer

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

Odgovor

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

---

Posodobi značko

Posodobite obstoječo značko. Spremenijo se le polja, ki jih posredujete.

PUT /badges/{badgeId}

Parametri

Parameter	Tip	Obvezno	Opis
badgeId	string	Da	ID značke (parameter poti)
name	string	Ne	Nov naslov značke
description	string	Ne	Nov opis
criteria	string	Ne	Nova merila
image	string	Ne	Nova slika, kodirana v Base64

Primer

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

Odgovor

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

---

Posodobi besedilo deljenja

Nastavite besedilo po meri, prikazano, ko prejemniki delijo to značko na družbenih omrežjih.

PUT /badges/{badgeId}/share-text

Parametri

Parameter	Tip	Obvezno	Opis
badgeId	string	Da	ID značke (parameter poti)
text	string	Da	Besedilo deljenja (HTML ni dovoljen)

Primer

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

Odgovor

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

---

Izbriši značko

Izbrišite značko. Značka ne sme imeti podelitev.

DELETE /badges/{badgeId}

Primer

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

Odgovor

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

Napake

• 400 — značka ima podelitve in je ni mogoče izbrisati
• 404 — značka ni najdena