Javna provjera

Ovi endpointi su javni i ne zahtijevaju autentifikaciju. Omogućuju bilo kome da provjeri vjerodajnice bedževa i dohvati JSON podatke Open Badge v2.0.

Svi endpointi su relativni u odnosu na https://api.badges.ninja.

Dohvati izdavatelja

Dohvatite JSON profila izdavatelja Open Badge v2.0 za danog izdavatelja.

GET /certify-badge/issuer/{guid}

Primjer

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

Odgovor

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

---

Dohvati bedž

Dohvatite JSON BadgeClass Open Badge v2.0 za dani bedž.

GET /certify-badge/badge/{guid}

Primjer

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

Odgovor

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

---

Dohvati dodjelu

Dohvatite JSON Assertion Open Badge v2.0 za danu dodjelu.

GET /certify-badge/award/{guid}

Primjer

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

Odgovor

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

Napomene

• E-pošta primatelja je hashirana (SHA-256) radi privatnosti, prema specifikaciji Open Badge.
• Odgovori se predmemoriraju 1 sat (Cache-Control: public, max-age=3600).

---

Dohvati tekst dijeljenja dodjele

Dohvatite prilagođeni tekst dijeljenja za bedž dodjele.

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

Primjer

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

Odgovor

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

Ako nije postavljen prilagođeni tekst dijeljenja, vraća se zadana poruka.

---

Pošalji e-poštu dodjele (javno)

Pošaljite e-poštu s obavijesti o dodjeli s javnog endpointa. To koristi javna stranica za dijeljenje.

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

Parametri

Parametar	Tip	Obvezno	Opis
recipients	string	Da	Popis adresa e-pošte odvojenih zarezima
subject	string	Ne	Predmet e-pošte
message	string	Ne	Prilagođena poruka koju treba uključiti u e-poštu

Primjer

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

Odgovor

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

---

Provjeri izdavatelja

Provjerite izdavatelja klikom na poveznicu za provjeru poslanu na e-poštu izdavatelja. Tome se obično pristupa preko poveznice u e-pošti za provjeru, ne poziva izravno.

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

Parametri

Parametar	Tip	Opis
guid	string	GUID izdavatelja
code	string	Kod za provjeru

Odgovor

Vraća HTML stranicu koja potvrđuje da je provjera uspjela ili nije. Ovaj endpoint je dizajniran za otvaranje u pregledniku.