Skip to content

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

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

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

Добијање издаваоца

Преузми JSON профил издаваоца у формату Open Badge v2.0 за дати издавалац.

GET /certify-badge/issuer/{guid}

Пример

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

Одговор

json
{
  "@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}

Пример

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

Одговор

json
{
  "@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}

Пример

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

Одговор

json
{
  "@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"
  }
}

Напомене

  • Имејл примаоца се хешира (SHA-256) ради приватности, у складу са спецификацијом Open Badge.
  • Одговори се кеширају на 1 сат (Cache-Control: public, max-age=3600).

Добијање текста за дељење награде

Преузми прилагођени текст за дељење за значку награде.

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

Пример

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

Одговор

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

Ако прилагођени текст није подешен, враћа се подразумевана порука.


Слање имејла о награди (јавно)

Пошаљите имејл обавештење о награди са јавне крајње тачке. Ово користи јавна страница за дељење.

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

Параметри

ПараметарТипОбавезноОпис
recipientsstringДаЛиста имејл адреса одвојена зарезима
subjectstringНеНаслов имејла
messagestringНеПрилагођена порука за укључивање у имејл

Пример

bash
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!"
    }
  }'

Одговор

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

Верификација издаваоца

Верификујте издаваоца кликом на верификациони линк послат на имејл издаваоца. Ово се обично приступа преко линка у имејлу верификације, а не позива директно.

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

Параметри

ПараметарТипОпис
guidstringGUID издаваоца
codestringВерификациони код

Одговор

Враћа HTML страницу која потврђује да је верификација успела или није успела. Ова крајња тачка је намењена отварању у прегледачу.

badges.ninja Documentation