Klucze API są jednym z podstawowych komponentów uwierzytelniania i bezpieczeństwa API i są odpowiednikiem nazwy użytkownika i hasła do Twojego konta Kraken.
Klucze API są wymagane do wywołania dowolnego z punktów końcowych API specyficznych dla konta (prywatnych), takich jak dane konta, transakcje, finansowanie oraz zarabianie. Klucze API nie są wymagane do wywoływania punktów końcowych API danych rynkowych (znanych jako publiczne), ponieważ punkty końcowe danych rynkowych nie są powiązane z żadnym konkretnym kontem Kraken.
Klucze API mogą być używane przez dowolne oprogramowanie, które wchodzi w interakcję z naszymi rynkami i kontami, takie jak nasze klienty wiersza poleceń REST API, niektóre aplikacje mobilne i platformy handlowe stron trzecich, boty handlowe stron trzecich i wiele innych produktów/usług.
- •Tworzenie klucza API
- •Konfiguracja klucza API (uprawnienia/ustawienia)
- •Używanie klucza API
- •Konfiguracja uwierzytelniania dwuskładnikowego (2FA) klucza API
Tworzenie klucza API
- •Otwórz menu konta (kliknij ikonę profilu w prawym górnym rogu strony).
- •Wybierz opcję Ustawienia.
- •Wybierz kartę API i kliknij opcję Utwórz klucz API.
Konfiguracja klucza API
Klucze API mają kilka ustawień i opcji, które muszą zostać skonfigurowane przed użyciem klucza API, w szczególności nazwę/opis i uprawnienia dostępu.
Opis klucza
Opis klucza to w rzeczy samej nazwa klucza API i może być ona dowolna, o ile opis jest unikalny (różni się od opisów innych kluczy API na tym samym koncie).
Opis klucza zostanie domyślnie uzupełniony i będzie wyglądał mniej więcej w ten sposób: "api-key-1605316109249". Ten domyślny opis można zachować lub zmienić na bardziej szczegółowy (taki jak "Klucz handlowy", "Klucz do zarządzania kontem", "Klucz API Python 6" lub "Klucz aplikacji mobilnej").
Uprawnienia klucza
Uprawnienia klucza określają, które punkty końcowe API specyficzne dla konta (prywatne) dany klucz API może wywoływać:
Środki
- •Zapytanie o środki jest wymagane dla punktów końcowych API, które wysyłają zapytania o informacje o saldzie konta, takie jak Balance i TradeBalance.
- •Wpłać środki jest wymagane dla punktów końcowych finansowania związanych z wpłatami, takich jak DepositMethods i DepositAddresses.
- •Wypłać środki jest wymagane dla punktów końcowych finansowania związanych z wypłatami, takich jak WithdrawInfo, Withdraw i WithdrawCancel.
Zlecenia i transakcje
- •Zapytanie otwarte zlecenia i transakcje jest wymagane dla punktów końcowych API, które sprawdzają już istniejące zlecenia i pozycje zlewarowane, takie jak OpenOrders, QueryOrders i OpenPositions.
- •Zapytanie zamknięte zlecenia i transakcje jest wymagane dla punktów końcowych, które wysyłają zapytania o wcześniej zamknięte/anulowane zlecenia i pozycje zlewarowane, takie jak ClosedOrders, QueryOrders i QueryTrades.
- •Modyfikuj zlecenia jest wymagane dla punktów końcowych transakcji, które składają nowe zlecenia, takie jak AddOrder, EditOrder i AddOrderBatch.
- •Anuluj/zamknij zlecenia jest wymagane dla punktów końcowych transakcji, które anulują otwarte lub oczekujące zlecenia, takie jak CancelOrder, CancelAll i CancelOrderBatch.
Inne
- •Zapytanie o wpisy w rejestrze jest wymagane dla punktów końcowych API, które pobierają historyczne dane z rejestru konta, a mianowicie Ledgers i QueryLedgers.
- •Eksportuj dane jest wymagane dla punktów końcowych, które eksportują (pobierają) rejestr konta, takie jak AddExport, RetrieveExport, ExportStatus i RemoveExport.
- •Dostęp do interfejsu API WebSocket jest wymagany do pobrania tokenu uwierzytelniania dla interfejsów API WebSocket za pośrednictwem punktu końcowego GetWebSocketsToken.
Jako przykład prawidłowego korzystania z uprawnień klucza API, pomyśl o kluczu API, który jest dostarczany stronie trzeciej do celów handlowych. Taki klucz API z pewnością wymagałby uprawnień Modyfikuj zlecenia i Anuluj/zamknij zlecenia, prawdopodobnie wymagałby uprawnień Zapytania o otwarte zlecenia i transakcje, ale prawie na pewno nie wymagałby uprawnień Wypłać środki.
Odpowiednio skonfigurowane uprawnienia pozwalają klientowi API na dokonywanie transakcji na koncie, ale uniemożliwiają klientowi API dostęp do jakichkolwiek informacji o koncie lub wykonywanie zadań związanych z finansowaniem.
Ustawienia opcjonalne
Pozostałe ustawienia klucza API są wymagane tylko do bardziej zaawansowanych konfiguracji, w związku z tym mogą być zazwyczaj pozostawione w wartościach domyślnych:
- •Okno nonce to ustawienie używane do radzenia sobie z problemami z siecią, które mogą powodować, że żądania API docierają poza kolejnością, poprzez zapewnienie krótkich ram czasowych (1 sekunda, 10 sekund itp.), podczas których żądania API z nieprawidłowym nonce (wartość nonce niższa niż poprzednio używana wartość nonce) nie spowodują błędu nieprawidłowego nonce.
- •Biała lista adresów IP to funkcja bezpieczeństwa, która ogranicza użycie klucza API do określonych adresów IP po stronie klienta.
- •Wygaśnięcie klucza można użyć do utworzenia klucza API, który działa tylko przez określony czas, na przykład klucz ważny tylko przez 1 tydzień.
- •Zapytanie Data/godzina rozpoczęcia/zakończenia to ustawienie, które ogranicza żądania danych historycznych konta do określonych ram czasowych, tak jak klucz, który może pobierać historię transakcji z tego roku, ale nie z poprzednich lat.
Po odpowiednim skonfigurowaniu ustawień klucza API, nowy klucz API można utworzyć, klikając przycisk Wygeneruj klucz.
WAŻNE: Klucz API, klucz prywatny i kod QR należy traktować tak samo jak swoją nazwę użytkownika i hasło. Zapisz je w menedżerze haseł, jeśli będzie konieczny dostęp do nich w późniejszym terminie. Nie zapisuj ich w niezaszyfrowanym formacie!
Używanie klucza API
Klucze API składają się z pary kluczy; publicznego i prywatnego. Oba muszą być dostarczone do oprogramowania klienckiego API.
Klucze API mogą być dostarczane na różne sposoby, na przykład:
- •Parę kluczy można skopiować i wkleić jako zwykły tekst bezpośrednio do kodu klienta API. Przykład: Metoda używana przez naszego klienta PHP API.
- •Parę kluczy można skopiować i wkleić do zwykłych plików tekstowych, do których klient API może mieć dostęp. Przykład: Metoda używana przez naszego klienta API wiersza poleceń.
Uwaga: Klucz prywatny jest również znany przez niektóre oprogramowanie klienckie API, jako sekretne API (lub po prostu jako sekret).
2FA dla klucza API
Klucze API zapewniają bezpieczny sposób na uwierzytelnienie dostępu API do konta Kraken, ale ich bezpieczeństwo można jeszcze zwiększyć, dodając uwierzytelnianie dwuskładnikowe (2FA).
2FA klucza API można dodać do istniejącego klucza API za pośrednictwem strony Bezpieczeństwo i może on używać hasła statycznego lub aplikacji Google Authenticator.
Uwaga: Dodanie 2FA do klucza API wymaga również od klienta API obsługiwania 2FA (dostarczania danych 2FA dla każdego wywołania prywatnych metod API), w przeciwnym razie zamiast pożądanego wyniku API zostanie zwrócony nieoczekiwany błąd.
Przeczytaj więcej o tym, jak działa 2FA dla kluczy API tutaj.