Julkinen varmistus

Nämä päätepisteet ovat julkisia eivätkä vaadi todennusta. Niiden avulla kuka tahansa voi varmistaa merkkitunnisteet ja hakea Open Badge v2.0 -JSON-tiedot.

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

Hae myöntäjä

Hae Open Badge v2.0 Issuer Profile -JSON tietylle myöntäjälle.

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 Open Badge v2.0 BadgeClass -JSON tietylle merkille.

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://ipfs.ninja/ipfs/Qm...",
  "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-..."
}

---

Hae myöntö

Hae Open Badge v2.0 Assertion -JSON tietylle myönnölle.

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

Huomautuksia

• Vastaanottajan sähköposti hashataan (SHA-256) yksityisyyden vuoksi Open Badge -spesifikaation mukaisesti.
• Vastaukset välimuistitetaan 1 tunnin ajan (Cache-Control: public, max-age=3600).

---

Hae myönnön jakamisteksti

Hae myönnön merkin mukautettu jakamisteksti.

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 jakamistekstiä ei ole asetettu, palautetaan oletusviesti.

---

Lähetä myöntösähköposti (julkinen)

Lähetä myönnöstä ilmoittava sähköposti julkisesta päätepisteestä. Tätä käytetään julkisella jakosivulla.

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

Parametrit

Parametri	Tyyppi	Pakollinen	Kuvaus
recipients	string	Kyllä	Pilkuilla erotettu luettelo sähköpostiosoitteista
subject	string	Ei	Sähköpostin aihe
message	string	Ei	Mukautettu viesti sähköpostiin sisällytettäväksi

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

---

Varmenna myöntäjä

Varmenna myöntäjä napsauttamalla myöntäjän sähköpostiin lähetettyä varmistuslinkkiä. Käytetään tyypillisesti varmistussähköpostin linkin kautta, ei kutsuta suoraan.

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

Parametrit

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

Vastaus

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