API наград

Создавайте и управляйте наградами значков (assertion-ами) — значками, выданными конкретным получателям.

Все эндпоинты требуют аутентификации через заголовок X-Api-Key. См. Аутентификация.

Создать награду

Выдать значок получателю.

POST /awards

Параметры

Параметр	Тип	Обязательно	Описание
badgeId	string	Да	ID значка для выдачи
recipient	object	Да	Данные получателя (см. ниже)
recipient.name	string	Да	Полное имя получателя (минимум 5 символов)
recipient.email	string	Да	E-mail получателя
issuedOn	string	Да	Дата выдачи в формате ISO 8601 (например, 2025-01-15)
expires	string	Нет	Дата окончания в формате ISO 8601
blockchain	string	Нет	Блокчейн для on-chain-верификации. Поддерживается только matchain. Доступен на тарифе Pro.

Пример

curl -X POST https://api.badges.ninja/awards \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "badgeId": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
      "recipient": {
        "name": "Jane Smith",
        "email": "jane@example.com"
      },
      "issuedOn": "2025-01-15"
    }
  }'

Ответ

{
  "statusCode": 200,
  "info": {
    "awardId": "https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012"
  }
}

Примечания

• Засчитывается как одна награда в месячную квоту (Free: 100/мес, Starter: 1 000/мес, Pro: 10 000/мес). Квота обнуляется каждый биллинговый период.
• Параметр blockchain доступен только на тарифе Pro.

---

Список наград

Получить награды с опциональной фильтрацией и пагинацией.

GET /awards

Query-параметры

Параметр	Тип	Обязательно	Описание
filter	JSON string	Нет	Объект фильтра (см. ниже)
lastEvaluatedKey	string	Нет	Токен пагинации из предыдущего ответа

Объект фильтра

Параметр filter принимает JSON-строку со следующими полями:

Поле	Тип	Описание
badgeId	string	Фильтр по ID значка.
search	string	Подстрока для поиска в именах или e-mail получателей (см. searchField).
searchField	string	name (по умолчанию) или email — по какому столбцу искать.

Пагинация через lastEvaluatedKey работает с фильтрами и без. Размер страницы — 50.

Пример — все награды

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

Пример — фильтр по значку

curl -X GET "https://api.badges.ninja/awards?filter=%7B%22badgeId%22%3A%22b1c2d3e4%22%7D" \
  -H "X-Api-Key: bws_your_api_key_here"

Ответ

{
  "statusCode": 200,
  "info": {
    "awards": [
      {
        "id": "https://api.badges.ninja/certify-badge/award/c1d2e3f4-...",
        "badge": {
          "id": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
          "name": "JavaScript Fundamentals",
          "image": "https://ipfs.ninja/ipfs/Qm..."
        },
        "recipient": {
          "name": "Jane Smith",
          "email": "jane@example.com"
        },
        "issuedOn": "2025-01-15T00:00:00.000Z",
        "timestamp": "2025-01-15T10:30:00.000Z"
      }
    ],
    "lastEvaluatedKey": "eyJ..."
  }
}

Если в ответе присутствует lastEvaluatedKey, есть ещё результаты. Передайте его как query-параметр в следующем запросе, чтобы получить следующую страницу.

---

Отправить письмо о награде

Отправить получателю уведомление о награде по e-mail.

POST /awards/{awardId}/send

Параметры

Параметр	Тип	Обязательно	Описание
awardId	string	Да	ID награды (path-параметр и body)
email	string	Да	E-mail получателя

Пример

curl -X POST https://api.badges.ninja/awards/c1d2e3f4-a5b6-7890-cdef-123456789012/send \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "awardId": "c1d2e3f4-a5b6-7890-cdef-123456789012",
      "email": "jane@example.com"
    }
  }'

Ответ

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

---

Поделиться наградой

Поделиться наградой с несколькими получателями по e-mail.

POST /awards/{awardId}/share

Параметры

Параметр	Тип	Обязательно	Описание
awardId	string	Да	ID награды (path-параметр и body)
recipients	string	Да	Список e-mail через запятую
subject	string	Да	Тема письма
message	string	Да	Текст сообщения

Пример

curl -X POST https://api.badges.ninja/awards/c1d2e3f4-a5b6-7890-cdef-123456789012/share \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "awardId": "c1d2e3f4-a5b6-7890-cdef-123456789012",
      "recipients": "manager@example.com,hr@example.com",
      "subject": "Check out my new badge!",
      "message": "I just earned the JavaScript Fundamentals badge."
    }
  }'

Ответ

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

---

Скачать PDF-сертификат

Сгенерировать готовый к печати PDF-сертификат A4 для награды.

GET /awards/{awardGuid}/pdf

Аутентификация не требуется — эндпоинт публичный, чтобы получатели могли скачивать свой сертификат.

Пример

curl -OJ https://api.badges.ninja/awards/c1d2e3f4-a5b6-7890-cdef-123456789012/pdf

Ответ — бинарный PDF с заголовком Content-Type: application/pdf.

---

Отследить событие награды

Записать событие вовлечения (view, share, download, LinkedIn add). Используется публичной страницей награды для наполнения статистики. Аутентификация не требуется.

POST /awards/{awardGuid}/event

Параметры

Параметр	Тип	Обязательно	Описание
kind	string	Да	Одно из view, share, download, linkedin_add.
network	string	Нет	При kind=share, соцсеть: linkedin, twitter, facebook, whatsapp, telegram, email, copy.

Подавление дубликатов на IP: одно и то же событие от одного IP засчитывается раз в 24 часа.

Пример

curl -X POST https://api.badges.ninja/awards/c1d2e3f4-a5b6-7890-cdef-123456789012/event \
  -H "Content-Type: application/json" \
  -d '{"parameters": {"kind": "share", "network": "linkedin"}}'

---

Получить статистику награды

Получить кумулятивные счётчики вовлечения для награды.

GET /awards/{awardGuid}/stats

Аутентификация не требуется.

Ответ

{
  "statusCode": 200,
  "info": {
    "stats": {
      "views": 142,
      "shares": { "linkedin": 8, "twitter": 2, "email": 1, "copy": 5 },
      "downloads": 3,
      "linkedin_adds": 4
    }
  }
}