Weryfikacja publiczna

Te endpointy są publiczne i nie wymagają uwierzytelnienia. Pozwalają każdemu weryfikować poświadczenia odznak oraz pobierać dane JSON Open Badge v2.0.

Wszystkie endpointy są względne do https://api.badges.ninja.

Pobierz wystawcę

Pobierz JSON profilu wystawcy Open Badge v2.0 dla danego wystawcy.

GET /certify-badge/issuer/{guid}

Przykład

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

Odpowiedź

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

---

Pobierz odznakę

Pobierz JSON BadgeClass Open Badge v2.0 dla danej odznaki.

GET /certify-badge/badge/{guid}

Przykład

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

Odpowiedź

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

---

Pobierz wydanie

Pobierz JSON Assertion Open Badge v2.0 dla danego wydania.

GET /certify-badge/award/{guid}

Przykład

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

Odpowiedź

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

Uwagi

• E-mail odbiorcy jest hashowany (SHA-256) ze względu na prywatność, zgodnie ze specyfikacją Open Badge.
• Odpowiedzi są cachowane przez 1 godzinę (Cache-Control: public, max-age=3600).

---

Pobierz tekst udostępnienia wydania

Pobierz własny tekst udostępnienia dla odznaki wydania.

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

Przykład

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

Odpowiedź

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

Jeśli własny tekst udostępnienia nie jest ustawiony, zwracana jest domyślna wiadomość.

---

Wyślij e-mail z wydaniem (publicznie)

Wyślij powiadomienie e-mail o wydaniu z publicznego endpointu. Używane przez publiczną stronę udostępniania.

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

Parametry

Parametr	Typ	Wymagany	Opis
recipients	string	Tak	Lista adresów e-mail rozdzielonych przecinkami
subject	string	Nie	Temat wiadomości
message	string	Nie	Własna wiadomość do zawarcia w e-mailu

Przykład

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

Odpowiedź

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

---

Weryfikuj wystawcę

Zweryfikuj wystawcę, klikając link weryfikacyjny wysłany na e-mail wystawcy. Zazwyczaj dostęp uzyskuje się przez link w wiadomości weryfikacyjnej, a nie przez bezpośrednie wywołanie.

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

Parametry

Parametr	Typ	Opis
guid	string	GUID wystawcy
code	string	Kod weryfikacyjny

Odpowiedź

Zwraca stronę HTML potwierdzającą powodzenie lub niepowodzenie weryfikacji. Ten endpoint jest zaprojektowany do otwierania w przeglądarce.