Publiskā verifikācija

Šie galapunkti ir publiski un neprasa autentifikāciju. Tie ļauj ikvienam verificēt nozīmju apliecinājumus un iegūt Open Badge v2.0 JSON datus.

Visi galapunkti ir norādīti attiecībā pret https://api.badges.ninja.

Iegūt izdevēju

Iegūstiet norādītā izdevēja Open Badge v2.0 Issuer Profile JSON.

GET /certify-badge/issuer/{guid}

Piemērs

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

Atbilde

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

---

Iegūt nozīmi

Iegūstiet norādītās nozīmes Open Badge v2.0 BadgeClass JSON.

GET /certify-badge/badge/{guid}

Piemērs

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

Atbilde

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

---

Iegūt apliecinājumu

Iegūstiet norādītā apliecinājuma Open Badge v2.0 Assertion JSON.

GET /certify-badge/award/{guid}

Piemērs

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

Atbilde

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

Ja apliecinājums ir atsaukts, assertion satur "revoked": true un, ja norādīts iemesls, arī "revocationReason" virkni:

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

Šis ir atsaukšanas skats saskaņā ar Open Badges 2.0. Tā pati atsaukšana ir izteikta arī apliecinājuma Open Badges 3.0 Verifiable Credential — skatiet Atsaukšana (Bitstring Status List).

Piezīmes

• Saņēmēja e-pasta adrese tiek jaukta (SHA-256) privātuma nolūkos, ievērojot Open Badge specifikāciju.
• Atbildes tiek kešotas 5 minūtes (Cache-Control: public, max-age=300). Atsauktiem apliecinājumiem tiek izmantota īsāka 30 sekunžu kešatmiņa (max-age=30), lai atsaukšana izplatītos ātri.

---

Iegūt apliecinājuma kopīgošanas tekstu

Iegūstiet apliecinājuma nozīmes pielāgoto kopīgošanas tekstu.

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

Piemērs

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

Atbilde

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

Ja pielāgots kopīgošanas teksts nav iestatīts, tiek atgriezts noklusējuma ziņojums.

---

Nosūtīt apliecinājuma e-pastu (publisks)

Nosūtiet apliecinājuma paziņojuma e-pastu no publiskā galapunkta. To izmanto publiskā kopīgošanas lapa.

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

Parametri

Parametrs	Tips	Obligāts	Apraksts
recipients	string	Jā	Ar komatiem atdalīts e-pasta adrešu saraksts
message	string	Nē	Pielāgots ziņojums, ko iekļaut e-pastā

Piemērs

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

Atbilde

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

Šis ir vienīgais galapunkts, kas ietver rezultātu { "statusCode", "info" } apvalkā. Visi pārējie galapunkti atgriež datus tieši.

---

Verificēt izdevēju

Verificējiet izdevēju, noklikšķinot uz verifikācijas saites, kas nosūtīta uz izdevēja e-pastu. Parasti tā tiek atvērta, izmantojot saiti verifikācijas e-pastā, nevis izsaukta tieši.

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

Parametri

Parametrs	Tips	Apraksts
guid	string	Izdevēja GUID
code	string	Verifikācijas kods

Atbilde

Atgriež HTML lapu, kas apstiprina, ka verifikācija bija sekmīga vai neizdevās. Šis galapunkts ir paredzēts atvēršanai pārlūkprogrammā.