Skip to content

API за значке

Управљајте шаблонима значки — акредитивима које додељујете примаоцима.

Све крајње тачке захтевају аутентификацију преко заглавља X-Api-Key. Видите Аутентификација.

Креирање значке

Креирајте нову значку под верификованим издаваоцем.

POST /badges

Параметри

ПараметарТипОбавезноОпис
namestringДаНаслов значке
descriptionstringДаШта значка представља
criteriastringДаШта је прималац учинио да заслужи значку
imagestringДаСлика кодирана у base64 (PNG или JPG)
issuerIdstringДаID верификованог издаваоца

Пример

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

Одговор

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

Напомене

  • Издавалац мора бити верификован пре креирања значки.
  • Слика се отпрема на IPFS ради трајног чувања.

Листа значки

Преузми све значке које сте креирали.

GET /badges

Пример

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

Одговор

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

Ажурирање значке

Ажурирајте постојећу значку. Мењају се само поља која проследите.

PUT /badges/{badgeId}

Параметри

ПараметарТипОбавезноОпис
badgeIdstringДаID значке (path параметар)
namestringНеНови наслов
descriptionstringНеНови опис
criteriastringНеНови критеријуми
imagestringНеНова слика кодирана у base64

Пример

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

Одговор

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

Ажурирање текста за дељење

Подесите прилагођени текст приказан када примаоци деле ову значку на друштвеним мрежама.

PUT /badges/{badgeId}/share-text

Параметри

ПараметарТипОбавезноОпис
badgeIdstringДаID значке (path параметар)
textstringДаТекст за дељење (HTML није дозвољен)

Пример

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

Одговор

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

Брисање значке

Обришите значку. Значка не сме имати награда.

DELETE /badges/{badgeId}

Пример

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

Одговор

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

Грешке

  • 400 — значка има награде и не може бити обрисана
  • 404 — значка није пронађена

badges.ninja Documentation