Badges API

Halda märgimalle — tõendeid, mida annad saajatele.

Kõik otspunktid nõuavad autentimist päise X-Api-Key kaudu. Vt Autentimine.

Loo märk

Loo uus märk kinnitatud väljastaja alla.

POST /badges

Parameetrid

Parameeter	Tüüp	Nõutav	Kirjeldus
name	string	Jah	Märgi pealkiri
description	string	Jah	Mida märk esindab
criteria	string	Jah	Mida saaja tegi selle märgi saamiseks
image	string	Jah	Base64-kodeeritud pilt (PNG või JPG)
issuerId	string	Jah	Kinnitatud väljastaja ID

Näide

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

Vastus

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

Märkused

• Väljastaja peab olema kinnitatud, enne kui saad luua märke.
• Pilt laaditakse üles IPFS-i püsivaks salvestuseks.

---

Loenda märgid

Hangi kõik sinu loodud märgid.

GET /badges

Näide

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

Vastus

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

---

Uuenda märki

Uuenda olemasolevat märki. Muudetakse ainult neid välju, mille esitad.

PUT /badges/{badgeId}

Parameetrid

Parameeter	Tüüp	Nõutav	Kirjeldus
badgeId	string	Jah	Märgi ID (tee-parameeter)
name	string	Ei	Uus märgi pealkiri
description	string	Ei	Uus kirjeldus
criteria	string	Ei	Uued kriteeriumid
image	string	Ei	Uus base64-kodeeritud pilt

Näide

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

Vastus

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

---

Uuenda jagamisteksti

Määra kohandatud tekst, mida kuvatakse, kui saajad seda märki sotsiaalmeedias jagavad.

PUT /badges/{badgeId}/share-text

Parameetrid

Parameeter	Tüüp	Nõutav	Kirjeldus
badgeId	string	Jah	Märgi ID (tee-parameeter)
text	string	Jah	Jagamistekst (HTML pole lubatud)

Näide

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

Vastus

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

---

Kustuta märk

Kustuta märk. Märgil ei tohi olla autasusid.

DELETE /badges/{badgeId}

Näide

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

Vastus

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

Vead

• 400 — märgil on autasud ja seda ei saa kustutada
• 404 — märki ei leitud