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 — значок не найден