Badges API

Upravljajte predlošcima bedževa — vjerodajnicama koje dodjeljujete primateljima.

Svi endpointi zahtijevaju autentifikaciju preko zaglavlja X-Api-Key. Pogledajte Autentifikacija.

Stvori bedž

Stvorite novi bedž pod provjerenim izdavateljem.

POST /badges

Parametri

Parametar	Tip	Obvezno	Opis
name	string	Da	Naslov bedža
description	string	Da	Što bedž predstavlja
criteria	string	Da	Što je primatelj učinio da zaradi ovaj bedž
image	string	Da	Slika kodirana u Base64 (PNG ili JPG)
issuerId	string	Da	ID provjerenog izdavatelja

Primjer

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

Napomene

• Izdavatelj mora biti provjeren prije stvaranja bedževa.
• Slika se učitava u IPFS za trajnu pohranu.

---

Popiši bedževe

Dohvatite sve bedževe koje ste stvorili.

GET /badges

Primjer

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

---

Ažuriraj bedž

Ažurirajte postojeći bedž. Mijenjaju se samo polja koja proslijedite.

PUT /badges/{badgeId}

Parametri

Parametar	Tip	Obvezno	Opis
badgeId	string	Da	ID bedža (parametar putanje)
name	string	Ne	Novi naslov bedža
description	string	Ne	Novi opis
criteria	string	Ne	Novi kriteriji
image	string	Ne	Nova slika kodirana u Base64

Primjer

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

---

Ažuriraj tekst dijeljenja

Postavite prilagođeni tekst prikazan kad primatelji dijele ovaj bedž na društvenim mrežama.

PUT /badges/{badgeId}/share-text

Parametri

Parametar	Tip	Obvezno	Opis
badgeId	string	Da	ID bedža (parametar putanje)
text	string	Da	Tekst dijeljenja (HTML nije dopušten)

Primjer

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

---

Obriši bedž

Obrišite bedž. Bedž ne smije imati dodjela.

DELETE /badges/{badgeId}

Primjer

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

Pogreške

• 400 — bedž ima dodjele i ne može se obrisati
• 404 — bedž nije pronađen