Weryfikacja publiczna

Te endpointy są publiczne i nie wymagają uwierzytelniania. Pozwalają każdemu zweryfikować poświadczenia odznak i pobrać dane JSON w formacie Open Badge v2.0.

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

Pobieranie wystawcy

Pobierz profil wystawcy w formacie JSON 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"
  }
}

---

Pobieranie odznaki

Pobierz BadgeClass w formacie JSON 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://badges.ninja/images/{sha256}.png",
  "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-..."
}

---

Pobieranie poświadczenia

Pobierz Assertion w formacie JSON Open Badge v2.0 dla danego poświadczenia.

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"
  },
  "revoked": false
}

Jeśli poświadczenie zostało unieważnione, asercja zawiera "revoked": true oraz — jeśli podano powód — ciąg "revocationReason":

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

Jest to widok unieważnienia zgodny z Open Badges 2.0. To samo unieważnienie jest również wyrażone w Verifiable Credential Open Badges 3.0 tego poświadczenia — zobacz Unieważnianie (Bitstring Status List).

Uwagi

• Adres e-mail odbiorcy jest haszowany (SHA-256) w celu ochrony prywatności, zgodnie ze specyfikacją Open Badge.
• Odpowiedzi są buforowane przez 5 minut (Cache-Control: public, max-age=300). Unieważnione poświadczenia używają krótszego, 30-sekundowego bufora (max-age=30), aby unieważnienie szybko się propagowało.

---

Pobieranie tekstu udostępniania poświadczenia

Pobierz własny tekst udostępniania dla odznaki danego poświadczenia.

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 nie ustawiono własnego tekstu udostępniania, zwracana jest wiadomość domyślna.

---

Wysyłanie e-maila z poświadczeniem (publiczne)

Wyślij e-mail z powiadomieniem o poświadczeniu z endpointu publicznego. Korzysta z niego publiczna strona udostępniania.

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

Parametry

Parametr	Typ	Wymagany	Opis
recipients	string	Tak	Lista adresów e-mail oddzielonych przecinkami
message	string	Nie	Własna wiadomość do dołączenia 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"
}

To jedyny endpoint, który opakowuje wynik w obiekt { "statusCode", "info" }. Każdy inny endpoint zwraca dane bezpośrednio.

---

Weryfikacja wystawcy

Zweryfikuj wystawcę, klikając link weryfikacyjny wysłany na adres e-mail wystawcy. Zazwyczaj otwiera się go z wiadomości weryfikacyjnej, a nie wywołuje bezpośrednio.

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ą, że weryfikacja zakończyła się powodzeniem lub niepowodzeniem. Ten endpoint jest przeznaczony do otwierania w przeglądarce.