Märkes-API

Hantera märkesmallar — meriterna du tilldelar mottagare.

Alla ändpunkter kräver autentisering via X-Api-Key-headern. Se Autentisering.

Skapa märke

Skapa ett nytt märke under en verifierad utfärdare.

POST /badges

Parametrar

Parameter	Typ	Obligatorisk	Beskrivning
name	string	Ja	Märkets titel
description	string	Ja	Vad märket representerar
criteria	string	Ja	Vad mottagaren gjorde för att förtjäna detta märke
image	string	Ja	Base64-kodad bild (PNG eller JPG)
issuerId	string	Ja	ID:t för den verifierade utfärdaren

Exempel

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

Svar

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

Anmärkningar

• Utfärdaren måste vara verifierad innan märken kan skapas.
• Bilden laddas upp till IPFS för permanent lagring.

---

Lista märken

Hämta alla märken du har skapat.

GET /badges

Exempel

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

Svar

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

---

Uppdatera märke

Uppdatera ett befintligt märke. Endast fälten du anger ändras.

PUT /badges/{badgeId}

Parametrar

Parameter	Typ	Obligatorisk	Beskrivning
badgeId	string	Ja	Märkes-ID (sökvägsparameter)
name	string	Nej	Ny märkestitel
description	string	Nej	Ny beskrivning
criteria	string	Nej	Nya kriterier
image	string	Nej	Ny base64-kodad bild

Exempel

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

Svar

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

---

Uppdatera delningstext

Sätt den anpassade texten som visas när mottagare delar detta märke på sociala medier.

PUT /badges/{badgeId}/share-text

Parametrar

Parameter	Typ	Obligatorisk	Beskrivning
badgeId	string	Ja	Märkes-ID (sökvägsparameter)
text	string	Ja	Delningstext (ingen HTML tillåten)

Exempel

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

Svar

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

---

Ta bort märke

Ta bort ett märke. Märket får inte ha några utmärkelser.

DELETE /badges/{badgeId}

Exempel

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

Svar

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

Fel

• 400 — märket har utmärkelser och kan inte tas bort
• 404 — märket hittades inte