Публичная верификация

Эти эндпоинты публичные и не требуют аутентификации. Они позволяют любому проверить удостоверения-значки и получить данные JSON Open Badge v2.0.

Все эндпоинты указаны относительно https://api.badges.ninja.

Получить эмитента

Получите JSON профиля эмитента Open Badge v2.0 для заданного эмитента.

GET /certify-badge/issuer/{guid}

Пример

curl https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-e5f6-7890-abcd-ef1234567890

Ответ

{
  "@context": "https://w3id.org/openbadges/v2",
  "type": "Issuer",
  "id": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
  "name": "Acme Academy",
  "url": "https://acme.example.com",
  "email": "badges@acme.example.com",
  "verification": {
    "type": "hosted",
    "allowedOrigins": "api.badges.ninja"
  }
}

---

Получить значок

Получите JSON BadgeClass Open Badge v2.0 для заданного значка.

GET /certify-badge/badge/{guid}

Пример

curl https://api.badges.ninja/certify-badge/badge/b1c2d3e4-f5a6-7890-bcde-f12345678901

Ответ

{
  "@context": "https://w3id.org/openbadges/v2",
  "type": "BadgeClass",
  "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 with a score of 80% or higher"
  },
  "image": "https://badges.ninja/images/{sha256}.png",
  "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-..."
}

---

Получить удостоверение

Получите JSON Assertion Open Badge v2.0 для заданного удостоверения.

GET /certify-badge/award/{guid}

Пример

curl https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012

Ответ

{
  "@context": "https://w3id.org/openbadges/v2",
  "type": "Assertion",
  "id": "https://api.badges.ninja/certify-badge/award/c1d2e3f4-...",
  "recipient": {
    "type": "email",
    "hashed": true,
    "identity": "sha256$..."
  },
  "badge": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
  "issuedOn": "2025-01-15T00:00:00.000Z",
  "verification": {
    "type": "hosted"
  },
  "revoked": false
}

Если удостоверение было отозвано, assertion содержит "revoked": true и, если указана причина, строку "revocationReason":

{
  "revoked": true,
  "revocationReason": "Issued in error"
}

Это представление отзыва в Open Badges 2.0. Тот же отзыв отражён и в Verifiable Credential Open Badges 3.0 для этого удостоверения — см. Отзыв (Bitstring Status List).

Примечания

• Адрес электронной почты получателя хешируется (SHA-256) для конфиденциальности в соответствии со спецификацией Open Badge.
• Ответы кешируются на 5 минут (Cache-Control: public, max-age=300). Для отозванных удостоверений используется более короткий кеш в 30 секунд (max-age=30), чтобы отзыв распространялся быстро.

---

Получить текст для публикации удостоверения

Получите пользовательский текст для публикации значка, связанного с удостоверением.

GET /certify-badge/award/{guid}/share-text

Пример

curl https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012/share-text

Ответ

{
  "text": "I just earned the JavaScript Fundamentals badge! Check it out:"
}

Если пользовательский текст для публикации не задан, возвращается сообщение по умолчанию.

---

Отправить письмо об удостоверении (публичный)

Отправьте письмо-уведомление об удостоверении через публичный эндпоинт. Он используется публичной страницей публикации.

POST /certify-badge/award/{guid}/send-email

Параметры

Параметр	Тип	Обязательный	Описание
recipients	string	Да	Список адресов электронной почты через запятую
message	string	Нет	Пользовательское сообщение для включения в письмо

Пример

curl -X POST https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012/send-email \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "recipients": "colleague@example.com",
      "message": "Check out this badge!"
    }
  }'

Ответ

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

Это единственный эндпоинт, который оборачивает результат в конверт { "statusCode", "info" }. Все остальные эндпоинты возвращают данные напрямую.

---

Верифицировать эмитента

Верифицируйте эмитента, перейдя по ссылке подтверждения, отправленной на адрес электронной почты эмитента. Обычно её открывают по ссылке из письма с подтверждением, а не вызывают напрямую.

GET /certify-badge/verify-issuer/{guid}/{code}

Параметры

Параметр	Тип	Описание
guid	string	GUID эмитента
code	string	Код верификации

Ответ

Возвращает HTML-страницу, подтверждающую успех или неудачу верификации. Этот эндпоинт предназначен для открытия в браузере.