Klucze API

Klucze API umożliwiają programowy dostęp do REST API badges.ninja. Używaj ich do automatyzacji tworzenia odznak, wystawiania i zarządzania z poziomu własnych aplikacji.

Tworzenie klucza API

1. Otwórz stronę Klucze API w pasku bocznym.
2. Kliknij Utwórz klucz API. Otworzy się formularz inline:

3. Nadaj kluczowi nazwę i kliknij Utwórz. Pełny klucz pojawi się jednorazowo na zielonym banerze:

4. Skopiuj klucz natychmiast — wyświetla się tylko raz. Jeśli go zgubisz, musisz utworzyć nowy. Po zamknięciu banera zapisany jest jedynie prefiks:

Zakresy dostępu

Tworząc klucz, możesz uczynić go tylko do odczytu lub pozostawić z pełnym dostępem:

Zakres	Zezwala na
Pełny dostęp (domyślnie)	Odczyt i zapis — wyświetlanie danych oraz tworzenie, wystawianie, aktualizowanie i usuwanie.
Tylko do odczytu	Tylko bezpieczne żądania GET. Każde żądanie modyfikujące (POST, PUT, PATCH, DELETE) jest odrzucane z 403 Forbidden.

Używaj klucza tylko do odczytu dla integracji, które muszą jedynie odczytywać Twoje dane (raportowanie, dashboardy, kopie zapasowe), aby wyciekły klucz nie mógł niczego zmienić. Zaznacz Read-only key w formularzu tworzenia; klucze tylko do odczytu pokazują odznakę Read-only na liście. Klucze utworzone przed istnieniem zakresów zachowują pełny dostęp.

Format klucza

Klucze API używają prefiksu bws_, po którym następuje 32-znakowy ciąg hex:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Używanie kluczy API w żądaniach

Dołącz klucz API w nagłówku X-Api-Key każdego żądania:

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

Zobacz stronę Uwierzytelnianie, aby uzyskać pełne informacje o uwierzytelnianiu w API.

Limity kluczy według planu

Liczba kluczy API, które możesz utworzyć, zależy od twojego planu:

Plan	Limit kluczy API
Free	1
Starter ($9/mies)	5
Pro ($29/mies)	20

Usuwanie klucza

1. Otwórz stronę Klucze API.
2. Znajdź klucz, który chcesz usunąć.
3. Kliknij Usuń.
4. Potwierdź usunięcie.

Po usunięciu klucz natychmiast przestaje działać. Wszelkie aplikacje używające tego klucza zwrócą błąd uwierzytelniania.