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

Ці кінцеві точки є публічними й не потребують автентифікації. Вони дозволяють будь-кому верифікувати сертифікати значків та отримувати дані Open Badge v2.0 у форматі JSON.

Усі кінцеві точки вказано відносно 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-сторінку, яка підтверджує, що верифікація пройшла успішно або не вдалася. Ця кінцева точка призначена для відкриття в браузері.