Dokumentacja API

Autoryzacja

Autoryzacja API

Wszystkie żądania API wymagają autoryzacji za pomocą klucza API. Ten przewodnik wyjaśnia, jak tworzyć, zarządzać i bezpiecznie używać kluczy API.

Uzyskiwanie klucza API

Aby uzyskać klucz API, musisz mieć konto iloveQR i być częścią organizacji.

Zaloguj się na swoje konto

Zaloguj się lub utwórz konto, jeśli go nie masz.

Przejdź do strony Deweloperzy

Przejdź do Panel → Deweloperzy, aby zarządzać swoimi kluczami API.

Utwórz nowy klucz API

Kliknij 'Utwórz klucz API', nadaj mu opisową nazwę i bezpiecznie przechowuj wygenerowany klucz.

Używanie swojego klucza API

Dołącz swój klucz API w nagłówku X-API-Key w każdym żądaniu:

Nagłówek żądania

curl -X GET \
  https://api.iloveqr.com/api/v1/organizations/YOUR_ORG_ID/qr-codes \
  -H "X-API-Key: ilqr_your_api_key_here" \
  -H "Content-Type: application/json"

ID organizacji

Większość punktów końcowych API wymaga ID organizacji w ścieżce URL. Możesz znaleźć swoje ID organizacji w ustawieniach panelu lub wykonując żądanie do punktu końcowego organizacji.

Uzyskaj swoje organizacje

curl -X GET \
  https://api.iloveqr.com/api/v1/users/me/organizations \
  -H "X-API-Key: ilqr_your_api_key_here"

Odpowiedź

{
  "organizations": [
    {
      "id": "org_abc123",
      "name": "My Company",
      "slug": "my-company",
      "role": "ADMIN"
    }
  ]
}

Najlepsze praktyki bezpieczeństwa

Nigdy nie ujawniaj kluczy API w kodzie po stronie klienta

Zawsze wykonuj wywołania API z serwera. Nigdy nie dołączaj kluczy API do JavaScript, który działa w przeglądarce, aplikacjach mobilnych ani żadnym kodzie, który może być widoczny dla użytkowników.

Używaj zmiennych środowiskowych

Przechowuj swoje klucze API w zmiennych środowiskowych, a nie w kodzie. Zapobiega to przypadkowemu ujawnieniu przez kontrolę wersji.

Regularnie zmieniaj klucze

Okresowo twórz nowe klucze API i unieważniaj stare. Jeśli podejrzewasz, że klucz został skompromitowany, natychmiast go unieważnij.

Błędy autoryzacji

Gdy autoryzacja się nie powiedzie, API zwraca jedną z tych odpowiedzi błędów:

Kod statusu	Błąd	Opis
401	UNAUTHORIZED	Brak lub nieprawidłowy klucz API
403	FORBIDDEN	Klucz API nie ma uprawnień do tej akcji
403	API_KEY_REVOKED	Klucz API został unieważniony

Przykładowa odpowiedź błędu

{
  "statusCode": 401,
  "message": "Invalid or missing API key",
  "error": "Unauthorized"
}

Kolejne kroki

Teraz, gdy rozumiesz autoryzację, dowiedz się, jak używać API: