API значків

Керуйте шаблонами значків — посвідченнями, які видаєте одержувачам.

Усі ендпоінти потребують автентифікації через заголовок X-Api-Key. Див. Автентифікація.

Створити значок

Створити новий значок під підтвердженим емітентом.

POST /badges

Параметри

Параметр	Тип	Обовʼязково	Опис
name	string	Так	Назва значка
description	string	Так	Що означає значок
criteria	string	Так	Що зробив одержувач, щоб заслужити значок
image	string	Так	Зображення в base64 (PNG або JPG)
issuerId	string	Так	ID підтвердженого емітента

Приклад

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

Відповідь

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

Примітки

• Емітент має бути підтверджений до створення значків.
• Зображення завантажується в IPFS для постійного зберігання.

---

Список значків

Отримати всі створені вами значки.

GET /badges

Приклад

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

Відповідь

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

Параметри

Параметр	Тип	Обовʼязково	Опис
badgeId	string	Так	ID значка (path-параметр)
name	string	Ні	Нова назва
description	string	Ні	Новий опис
criteria	string	Ні	Нові критерії
image	string	Ні	Нове зображення в base64

Приклад

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

Відповідь

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

---

Оновити текст шерингу

Задати користувацький текст, який відображається при шерингу значка в соцмережах.

PUT /badges/{badgeId}/share-text

Параметри

Параметр	Тип	Обовʼязково	Опис
badgeId	string	Так	ID значка (path-параметр)
text	string	Так	Текст шерингу (HTML не допускається)

Приклад

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

Відповідь

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

---

Видалити значок

Видалити значок. У значка не повинно бути нагород.

DELETE /badges/{badgeId}

Приклад

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

Відповідь

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

Помилки

• 400 — у значка є нагороди, видалення неможливе
• 404 — значок не знайдено