Offentlig verificering

Disse endpoints er offentlige og kræver ikke godkendelse. De giver alle mulighed for at verificere mærkebeviser og hente Open Badge v2.0-JSON-data.

Alle endpoints er relative til https://api.badges.ninja.

Hent udsteder

Hent Open Badge v2.0 Issuer Profile-JSON for en given udsteder.

GET /certify-badge/issuer/{guid}

Eksempel

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

Svar

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

---

Hent mærke

Hent Open Badge v2.0 BadgeClass-JSON for et givet mærke.

GET /certify-badge/badge/{guid}

Eksempel

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

Svar

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

---

Hent udmærkelse

Hent Open Badge v2.0 Assertion-JSON for en given udmærkelse.

GET /certify-badge/award/{guid}

Eksempel

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

Svar

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

Bemærkninger

• Modtagerens e-mail hashes (SHA-256) af hensyn til privatlivet, i overensstemmelse med Open Badge-specen.
• Svar caches i 1 time (Cache-Control: public, max-age=3600).

---

Hent udmærkelsens delingstekst

Hent den tilpassede delingstekst for en udmærkelses mærke.

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

Eksempel

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

Svar

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

Hvis ingen tilpasset delingstekst er sat, returneres en standardbesked.

---

Send udmærkelses-e-mail (offentlig)

Send en udmærkelsesnotifikation via e-mail fra det offentlige endpoint. Dette bruges af den offentlige delingsside.

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

Parametre

Parameter	Type	Påkrævet	Beskrivelse
recipients	string	Ja	Kommaadskilt liste med e-mailadresser
subject	string	Nej	E-mailens emne
message	string	Nej	Tilpasset besked, der skal inkluderes i e-mailen

Eksempel

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

Svar

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

---

Verificér udsteder

Verificér en udsteder ved at klikke på verificeringslinket sendt til udstederens e-mail. Tilgås typisk via linket i verificerings-e-mailen, ikke kaldes direkte.

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

Parametre

Parameter	Type	Beskrivelse
guid	string	Udstederens GUID
code	string	Verificeringskoden

Svar

Returnerer en HTML-side, der bekræfter, om verificeringen lykkedes eller mislykkedes. Dette endpoint er designet til at blive åbnet i en browser.