Uwierzytelnianie

Wszystkie żądania API do badges.ninja wymagają uwierzytelnienia. Ta strona wyjaśnia, jak uwierzytelniać swoje żądania.

Bazowy URL

https://api.badges.ninja

Wszystkie endpointy API są podawane względem tego bazowego URL.

Uwierzytelnianie kluczem API

Podstawową metodą uwierzytelniania jest klucz API przekazywany w nagłówku X-Api-Key.

Uzyskiwanie klucza API

Z panelu:

1. Zaloguj się na badges.ninja.
2. Przejdź do Klucze API na pasku bocznym.
3. Kliknij Utwórz klucz API.
4. Skopiuj klucz (jest wyświetlany tylko raz).

Z poziomu API:

Kluczami API można też zarządzać przez API, używając tokenu JWT z przepływu uwierzytelniania Cognito. Najprostszym rozwiązaniem jest jednak panel.

Używanie klucza API

Dołącz nagłówek X-Api-Key do każdego żądania:

curl -X GET https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here"

Format klucza API

Klucze mają prefiks bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Format żądań

• Żądania GET przekazują parametry jako ciąg zapytania (query string)
• Żądania POST i PUT wysyłają treść JSON z obiektem parameters
• Wszystkie odpowiedzi zwracają JSON z nagłówkiem Content-Type: application/json

Struktura żądania POST/PUT

{
  "parameters": {
    "name": "My Badge",
    "description": "A sample badge"
  }
}

Przykładowe żądanie

curl -X POST https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "My Organization",
      "url": "https://example.com",
      "email": "admin@example.com"
    }
  }'

Przykładowa odpowiedź

{
  "issuerId": "https://api.badges.ninja/certify-badge/issuer/abc123-def456"
}

Endpointy publiczne

Niektóre endpointy nie wymagają uwierzytelnienia. Są to publiczne endpointy weryfikacji pod ścieżką /certify-badge/, które pozwalają każdemu zweryfikować poświadczenia odznak.