Jelvények API

Kezeld a jelvénysablonokat — a címzetteknek kiadott bizonyítványokat.

Minden végpont az X-Api-Key fejléccel történő hitelesítést igényli. Lásd: Hitelesítés.

Jelvény létrehozása

Hozz létre új jelvényt egy ellenőrzött kibocsátó alatt.

POST /badges

Paraméterek

Paraméter	Típus	Kötelező	Leírás
name	string	Igen	Jelvénycím
description	string	Igen	Mit képvisel a jelvény
criteria	string	Igen	Mit tett a címzett ennek a jelvénynek a megszerzéséért
image	string	Igen	Base64-kódolású kép (PNG vagy JPG)
issuerId	string	Igen	Az ellenőrzött kibocsátó azonosítója

Példa

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

Válasz

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

Megjegyzések

• A kibocsátónak ellenőrzöttnek kell lennie a jelvények létrehozása előtt.
• A kép tartós tároláshoz az IPFS-re kerül.

---

Jelvények listázása

Kérj le minden létrehozott jelvényt.

GET /badges

Példa

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

Válasz

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

---

Jelvény frissítése

Meglévő jelvény frissítése. Csak a megadott mezők módosulnak.

PUT /badges/{badgeId}

Paraméterek

Paraméter	Típus	Kötelező	Leírás
badgeId	string	Igen	A jelvény azonosítója (elérési útban)
name	string	Nem	Új cím
description	string	Nem	Új leírás
criteria	string	Nem	Új kritériumok
image	string	Nem	Új base64-kódolású kép

Példa

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

Válasz

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

---

Megosztási szöveg frissítése

Állítsd be azt az egyéni szöveget, amely megjelenik, amikor a címzettek ezt a jelvényt megosztják a közösségi médiában.

PUT /badges/{badgeId}/share-text

Paraméterek

Paraméter	Típus	Kötelező	Leírás
badgeId	string	Igen	A jelvény azonosítója (elérési útban)
text	string	Igen	A megosztási szöveg (HTML nem megengedett)

Példa

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

Válasz

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

---

Jelvény törlése

Jelvény törlése. A jelvényhez nem tartozhat kiadás.

DELETE /badges/{badgeId}

Példa

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

Válasz

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

Hibák

• 400 — a jelvényhez kiadások tartoznak, így nem törölhető
• 404 — a jelvény nem található