Offentlig verifisering

Disse endepunktene er offentlige og krever ikke autentisering. De lar hvem som helst verifisere merkepoeng (badge-legitimasjon) og hente Open Badge v2.0 JSON-data.

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

Get Issuer

Hent JSON for Open Badge v2.0 Issuer Profile for en gitt utsteder.

GET /certify-badge/issuer/{guid}

Eksempel

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

Respons

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

---

Get Badge

Hent JSON for Open Badge v2.0 BadgeClass for et gitt digitalt merke.

GET /certify-badge/badge/{guid}

Eksempel

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

Respons

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

---

Get Credential

Hent JSON for Open Badge v2.0 Assertion for en gitt legitimasjon.

GET /certify-badge/award/{guid}

Eksempel

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

Respons

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

Hvis legitimasjonen er tilbakekalt, inneholder assertion "revoked": true og, når det er oppgitt en årsak, en "revocationReason"-streng:

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

Dette er Open Badges 2.0-visningen av tilbakekalling. Den samme tilbakekallingen uttrykkes også i legitimasjonens Open Badges 3.0 Verifiable Credential — se Tilbakekalling (Bitstring Status List).

Merknader

• Mottakerens e-postadresse hashes (SHA-256) av hensyn til personvern, i tråd med Open Badge-spesifikasjonen.
• Svar mellomlagres i 5 minutter (Cache-Control: public, max-age=300). Tilbakekalte legitimasjoner bruker en kortere mellomlagring på 30 sekunder (max-age=30), slik at tilbakekallingen sprer seg raskt.

---

Get Credential Share Text

Hent den egendefinerte delingsteksten for en legitimasjons merke.

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

Eksempel

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

Respons

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

Hvis ingen egendefinert delingstekst er satt, returneres en standardmelding.

---

Send Credential Email (Public)

Send en e-post med varsel om legitimasjon fra det offentlige endepunktet. Dette brukes av den offentlige delingssiden.

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

Parametere

Parameter	Type	Påkrevd	Beskrivelse
recipients	string	Ja	Kommaseparert liste over e-postadresser
message	string	Nei	Egendefinert melding som tas med i e-posten

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

Respons

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

Dette er det eneste endepunktet som pakker resultatet inn i en { "statusCode", "info" }-konvolutt. Alle andre endepunkter returnerer nyttelasten direkte.

---

Verify Issuer

Verifiser en utsteder ved å klikke på verifiseringslenken som er sendt til utstederens e-postadresse. Dette åpnes vanligvis via lenken i verifiserings-e-posten, og kalles ikke direkte.

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

Parametere

Parameter	Type	Beskrivelse
guid	string	Utstederens GUID
code	string	Verifiseringskoden

Respons

Returnerer en HTML-side som bekrefter at verifiseringen lyktes eller mislyktes. Dette endepunktet er laget for å åpnes i en nettleser.