Skip to content

Verificare publică

Aceste endpoint-uri sunt publice și nu necesită autentificare. Permit oricui să verifice credențiale și să obțină date JSON Open Badge v2.0.

Toate endpoint-urile sunt relative la https://api.badges.ninja.

Obține emitentul

Recuperează JSON-ul Issuer Profile Open Badge v2.0 pentru un emitent.

GET /certify-badge/issuer/{guid}

Exemplu

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

Răspuns

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

Obține credențiala

Recuperează JSON-ul BadgeClass Open Badge v2.0 pentru o credențială.

GET /certify-badge/badge/{guid}

Exemplu

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

Răspuns

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

Obține acordarea

Recuperează JSON-ul Assertion Open Badge v2.0 pentru o acordare.

GET /certify-badge/award/{guid}

Exemplu

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

Răspuns

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

Note

  • E-mailul destinatarului este criptat cu hash (SHA-256) pentru confidențialitate, conform specificației Open Badge.
  • Răspunsurile sunt păstrate în cache timp de 1 oră (Cache-Control: public, max-age=3600).

Obține textul de distribuire al acordării

Recuperează textul de distribuire personalizat al credențialei unei acordări.

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

Exemplu

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

Răspuns

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

Dacă nu este setat niciun text personalizat, se returnează un mesaj implicit.


Trimite e-mail de acordare (public)

Trimite o notificare prin e-mail de la endpoint-ul public. Este folosit de pagina publică de distribuire.

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

Parametri

ParametruTipObligatoriuDescriere
recipientsstringDaListă de adrese de e-mail separate prin virgulă
subjectstringNuSubiectul e-mailului
messagestringNuMesaj personalizat de inclus în e-mail

Exemplu

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

Răspuns

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

Verifică emitentul

Verifică un emitent accesând linkul de verificare trimis la adresa lui de e-mail. De regulă se accesează prin linkul din e-mail, nu se apelează direct.

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

Parametri

ParametruTipDescriere
guidstringGUID-ul emitentului
codestringCodul de verificare

Răspuns

Returnează o pagină HTML care confirmă dacă verificarea a reușit sau nu. Acest endpoint este proiectat să fie deschis într-un browser.

badges.ninja Documentation