Јавна верификација

Ове крајње тачке су јавне и не захтевају аутентификацију. Омогућавају свима да верификују акредитиве значки и преузму Open Badge v2.0 JSON податке.

Све крајње тачке су релативне у односу на https://api.badges.ninja.

Преузимање издаваоца

Преузмите Open Badge v2.0 Issuer Profile JSON за одређеног издаваоца.

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"
  }
}

---

Преузимање значке

Преузмите Open Badge v2.0 BadgeClass JSON за одређену значку.

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-..."
}

---

Преузимање акредитива

Преузмите Open Badge v2.0 Assertion JSON за одређени акредитив.

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. Исти опозив је изражен и у Open Badges 3.0 Verifiable Credential-у тог акредитива — погледајте Опозив (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 страницу која потврђује да је верификација успела или није успела. Ова крајња тачка је намењена отварању у прегледачу.