Badges API

Pārvaldiet nozīmju veidnes — apliecinājumus, ko pasniedzat saņēmējiem.

Visi galapunkti prasa autentifikāciju caur galveni X-Api-Key. Skatiet Autentifikācija.

Izveidot nozīmi

Izveidojiet jaunu nozīmi zem pārbaudīta izsniedzēja.

POST /badges

Parametri

Parametrs	Tips	Obligāts	Apraksts
name	string	Jā	Nozīmes virsraksts
description	string	Jā	Ko nozīme atspoguļo
criteria	string	Jā	Ko saņēmējs izdarīja, lai nopelnītu šo nozīmi
image	string	Jā	Base64 kodēts attēls (PNG vai JPG)
issuerId	string	Jā	Pārbaudīta izsniedzēja ID

Piemērs

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

Atbilde

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

Piezīmes

• Izsniedzējam jābūt pārbaudītam pirms nozīmju izveides.
• Attēls tiek augšupielādēts IPFS pastāvīgai krātuvei.

---

Uzskaitīt nozīmes

Iegūt visas jūsu izveidotās nozīmes.

GET /badges

Piemērs

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

Atbilde

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

---

Atjaunināt nozīmi

Atjaunināt esošu nozīmi. Tiek mainīti tikai tie lauki, kurus norādāt.

PUT /badges/{badgeId}

Parametri

Parametrs	Tips	Obligāts	Apraksts
badgeId	string	Jā	Nozīmes ID (ceļa parametrs)
name	string	Nē	Jauns nozīmes virsraksts
description	string	Nē	Jauns apraksts
criteria	string	Nē	Jauni kritēriji
image	string	Nē	Jauns base64 kodēts attēls

Piemērs

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

Atbilde

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

---

Atjaunināt dalīšanās tekstu

Iestatiet pielāgoto tekstu, kas tiek parādīts, kad saņēmēji dalās ar šo nozīmi sociālajos plašsaziņas līdzekļos.

PUT /badges/{badgeId}/share-text

Parametri

Parametrs	Tips	Obligāts	Apraksts
badgeId	string	Jā	Nozīmes ID (ceļa parametrs)
text	string	Jā	Dalīšanās teksts (HTML nav atļauts)

Piemērs

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

Atbilde

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

---

Dzēst nozīmi

Dzēst nozīmi. Nozīmei nedrīkst būt apbalvojumu.

DELETE /badges/{badgeId}

Piemērs

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

Atbilde

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

Kļūdas

• 400 — nozīmei ir apbalvojumi un to nevar dzēst
• 404 — nozīme nav atrasta