Offentlig verifiering

De här slutpunkterna är offentliga och kräver ingen autentisering. Med dem kan vem som helst verifiera märkes-credentials och hämta Open Badge v2.0 JSON-data.

Alla slutpunkter är relativa till https://api.badges.ninja.

Hämta utfärdare

Hämta Open Badge v2.0 Issuer Profile JSON för en given utfärdare.

GET /certify-badge/issuer/{guid}

Exempel

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

---

Hämta märke

Hämta Open Badge v2.0 BadgeClass JSON för ett givet märke.

GET /certify-badge/badge/{guid}

Exempel

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://badges.ninja/images/{sha256}.png",
  "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-..."
}

---

Hämta credential

Hämta Open Badge v2.0 Assertion JSON för en given credential.

GET /certify-badge/award/{guid}

Exempel

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"
  },
  "revoked": false
}

Om credentialen har återkallats innehåller assertionen "revoked": true och, när en orsak har angetts, en sträng "revocationReason":

{
  "revoked": true,
  "revocationReason": "Issued in error"
}

Detta är Open Badges 2.0-vyn av en återkallelse. Samma återkallelse uttrycks också i credentialens Open Badges 3.0 Verifiable Credential — se Återkallelse (Bitstring Status List).

Anmärkningar

• Mottagarens e-postadress hashas (SHA-256) av integritetsskäl, i enlighet med Open Badge-specifikationen.
• Svaren cachas i 5 minuter (Cache-Control: public, max-age=300). Återkallade credentials använder en kortare cache på 30 sekunder (max-age=30) så att återkallelsen sprids snabbt.

---

Hämta delningstext för credential

Hämta den anpassade delningstexten för en credentials märke.

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

Exempel

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

Om ingen anpassad delningstext har angetts returneras ett standardmeddelande.

---

Skicka credential-e-post (offentlig)

Skicka ett e-postmeddelande om en credential från den offentliga slutpunkten. Den används av den offentliga delningssidan.

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

Parametrar

Parameter	Typ	Obligatorisk	Beskrivning
recipients	string	Ja	Kommaseparerad lista med e-postadresser
message	string	Nej	Anpassat meddelande som ska ingå i e-postmeddelandet

Exempel

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

Det här är den enda slutpunkten som lindar in sitt resultat i ett { "statusCode", "info" }-kuvert. Alla andra slutpunkter returnerar sin nyttolast direkt.

---

Verifiera utfärdare

Verifiera en utfärdare genom att klicka på verifieringslänken som skickas till utfärdarens e-postadress. Den nås vanligtvis via länken i verifieringsmejlet och anropas inte direkt.

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

Parametrar

Parameter	Typ	Beskrivning
guid	string	Utfärdarens GUID
code	string	Verifieringskoden

Svar

Returnerar en HTML-sida som bekräftar att verifieringen lyckades eller misslyckades. Slutpunkten är avsedd att öppnas i en webbläsare.