Julkinen varmennus

Nämä päätepisteet ovat julkisia, eivätkä ne vaadi todennusta. Niiden avulla kuka tahansa voi varmentaa merkkitodistuksia ja hakea Open Badge v2.0 -JSON-tietoja.

Kaikki päätepisteet ovat suhteessa osoitteeseen https://api.badges.ninja.

Hae myöntäjä

Hae tietyn myöntäjän Open Badge v2.0 -myöntäjäprofiilin (Issuer Profile) JSON.

GET /certify-badge/issuer/{guid}

Esimerkki

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

Vastaus

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

---

Hae merkki

Hae tietyn merkin Open Badge v2.0 -BadgeClass-JSON.

GET /certify-badge/badge/{guid}

Esimerkki

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

Vastaus

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

---

Hae todistus

Hae tietyn todistuksen Open Badge v2.0 -Assertion-JSON.

GET /certify-badge/award/{guid}

Esimerkki

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

Vastaus

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

Jos todistus on mitätöity, assertionissa on "revoked": true ja, jos syy on annettu, "revocationReason"-merkkijono:

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

Tämä on mitätöinnin Open Badges 2.0 -näkymä. Sama mitätöinti ilmaistaan myös todistuksen Open Badges 3.0 Verifiable Credentialissa — katso Mitätöinti (Bitstring Status List).

Huomautuksia

• Vastaanottajan sähköpostiosoite tiivistetään (SHA-256) yksityisyyden suojaamiseksi Open Badge -määrittelyn mukaisesti.
• Vastaukset tallennetaan välimuistiin 5 minuutiksi (Cache-Control: public, max-age=300). Mitätöidyille todistuksille käytetään lyhyempää 30 sekunnin välimuistia (max-age=30), jotta mitätöinti leviää nopeasti.

---

Hae todistuksen jakoteksti

Hae todistuksen merkin mukautettu jakoteksti.

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

Esimerkki

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

Vastaus

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

Jos mukautettua jakotekstiä ei ole asetettu, palautetaan oletusviesti.

---

Lähetä todistussähköposti (julkinen)

Lähetä todistuksen ilmoitussähköposti julkisesta päätepisteestä. Julkinen jakosivu käyttää tätä.

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

Parametrit

Parametri	Tyyppi	Pakollinen	Kuvaus
recipients	string	Kyllä	Pilkuilla erotettu luettelo sähköpostiosoitteista
message	string	Ei	Sähköpostiin sisällytettävä mukautettu viesti

Esimerkki

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

Vastaus

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

Tämä on ainoa päätepiste, joka kääri tuloksensa { "statusCode", "info" }-vaippaan. Kaikki muut päätepisteet palauttavat sisältönsä suoraan.

---

Varmenna myöntäjä

Varmenna myöntäjä klikkaamalla myöntäjän sähköpostiin lähetettyä varmennuslinkkiä. Tähän päästään yleensä varmennussähköpostin linkin kautta, eikä sitä kutsuta suoraan.

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

Parametrit

Parametri	Tyyppi	Kuvaus
guid	string	Myöntäjän GUID
code	string	Varmennuskoodi

Vastaus

Palauttaa HTML-sivun, joka vahvistaa varmennuksen onnistumisen tai epäonnistumisen. Tämä päätepiste on tarkoitettu avattavaksi selaimessa.