Offentlig verifisering

Disse endepunktene er offentlige og krever ikke autentisering. De lar alle verifisere merkebevis og hente Open Badge v2.0-JSON-data.

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

Hent utsteder

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

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 merke

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

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 tildeling

Hent Open Badge v2.0 Assertion-JSON for en gitt tildeling.

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

Merknader

• Mottakerens e-post hashes (SHA-256) av hensyn til personvernet, i tråd med Open Badge-specen.
• Svar mellomlagres i 1 time (Cache-Control: public, max-age=3600).

---

Hent tildelingens delingstekst

Hent den tilpassede delingsteksten for en tildelings merke.

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 satt, returneres en standardmelding.

---

Send tildelings-e-post (offentlig)

Send en tildelingsvarsel-e-post 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	Kommaadskilt liste med e-postadresser
subject	string	Nei	E-postens emne
message	string	Nei	Tilpasset melding som skal inkluderes 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!"
    }
  }'

Svar

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

---

Verifiser utsteder

Verifiser en utsteder ved å klikke på verifiseringslenken sendt til utstederens e-post. Aksesseres vanligvis via lenken i verifiserings-e-posten, ikke kalles direkte.

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

Parametere

Parameter	Type	Beskrivelse
guid	string	Utstederens GUID
code	string	Verifiseringskoden

Svar

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