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

Ці ендпоінти публічні й не потребують автентифікації. Вони дозволяють будь-кому перевіряти посвідчення значків і отримувати 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://ipfs.ninja/ipfs/Qm...",
  "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"
  }
}

Примітки

• E-mail одержувача хешується (SHA-256) для приватності, згідно зі специфікацією Open Badge.
• Відповіді кешуються на 1 годину (Cache-Control: public, max-age=3600).

---

Отримати текст шерингу нагороди

Отримати користувацький текст шерингу для значка нагороди.

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	Так	Список e-mail через кому
subject	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"
}

---

Підтвердити емітента

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

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

Параметри

Параметр	Тип	Опис
guid	string	GUID емітента
code	string	Код підтвердження

Відповідь

Повертає HTML-сторінку з підтвердженням успіху чи невдачі. Цей ендпоінт призначений для відкриття в браузері.