API-nycklar är en av huvudkomponenterna för API-autentisering och säkerhet – de är API-motsvarigheten till användarnamn och lösenord för ditt Kraken-konto.
API-nycklar krävs för att anropa några av de kontospecifika (privata) API-slutpunkterna, såsom slutpunkterna för kontodata, handel, finansiering och intäkter. API-nycklar krävs inte för att anropa de (offentliga) API-slutpunkterna för marknadsdata, eftersom slutpunkterna för marknadsdata inte är kopplade till något specifikt Kraken-konto.
API-nycklar kan användas av all programvara som interagerar med våra marknader och konton, såsom våra REST API-kommandoradverktyg, mobilappar och handelsplattformar från tredjepart, handelsrobotar från tredjepart och en rad andra produkter/tjänster.
Skapa en API-nyckel
Konfigurera en API-nyckel (behörigheter/inställningar)
Använda en API-nyckel
API-nyckel tvåfaktorsautentisering (2FA)
Öppna kontomenyn (klicka på profilikonen i det övre högra hörnet av sidan).
Välj alternativet Inställningar.
Välj fliken API och klicka på Skapa API-nyckel.
API-nycklar har flera inställningar och alternativ som måste konfigureras innan API-nyckeln kan användas, i synnerhet namn/beskrivning och åtkomstbehörigheter.
Nyckelbeskrivning
Nyckelbeskrivningen är i princip API-nyckelns namn och kan vara nästan vad som helst, så länge beskrivningen är unik (annorlunda än beskrivningarna av andra API-nycklar på samma konto).
Som standard kommer nyckelbeskrivningen att anges som något i stil med ”api-key-1605316109249”. Du kan behålla standardbeskrivningen eller ändra den till ett mer beskrivande namn (till exempel ”handelsnyckel”, ”kontohanteringsnyckel” eller ”Python API-nyckel 6”).
Nyckelbehörigheter
Nyckelbehörigheterna avgör vilka kontospecifika (privata) API-slutpunkter API-nyckeln har rätt att anropa:
Fråga efter medel krävs för API-slutpunkter som efterfrågar information om kontosaldon, som Balance och TradeBalance.
Sätt in medel krävs för finansieringsslutpunkter kopplade till insättningar, som DepositMethods och DepositAddresses.
Ta ut medel krävs för finansieringsslutpunkter kopplade till uttag, som WithdrawInfo, Withdraw och WithdrawCancel.
Fråga efter öppna order och affärer krävs för de API-slutpunkter som efterfrågar befintliga ordrar och marginalpositioner, som OpenOrders, QueryOrders och OpenPositions.
Fråga efter stängda ordrar och affärer krävs för slutpunkter som efterfrågar tidigare stängda/annullerade ordrar och marginalpositioner, som ClosedOrders, QueryOrders och QueryTrades.
Ändra ordrar krävs för de handelsslutpunkter som lägger nya ordrar, som AddOrder, EditOrder och AddOrderBatch.
Avbryt/stäng order krävs för handelsslutpunkter som annullerar öppna eller väntande ordrar, som CancelOrder, CancelAll och CancelOrderBatch.
Fråga efter bokföringsposter krävs för API-slutpunkter som hämtar historiska kontodata från kontots huvudbok, främst Ledgers och QueryLedgers.
Exportera data krävs för slutpunkter som exporterar (laddar ned) kontots huvudbok, främst AddExport, RetrieveExport, ExportStatus och RemoveExport.
Åtkomst till WebSockets API krävs för att hämta ett autentiseringtoken för WebSocket API:er via slutpunkten GetWebSocketsToken.
Vi tar ett exempel på korrekt användning av API-nyckelbehörigheter: tänk dig att en API-nyckel tillhandahålls till en tredje part för handelsändamål. Ett sådant API skulle definitivt behöva behörigheterna Ändra ordrar och Avbryt/stäng order, skulle antagligen behöva behörigheten Fråga efter stängda ordrar och affärer, men skulle knappast behöva behörigheten Ta ut medel.
Korrekt konfigurerade behörigheter ger API-klienten möjlighet att handla för kontot, men förhindrar att API-klienten kommer åt kontoinformation eller utför finansieringsåtgärder.
Frivilliga inställningar
Återstående API-nyckelinställningar krävs endast för mer avancerade konfigurationer och kan vanligtvis behållas på sina standardvärden:
Nonce-fönster är en inställning som används för att åtgärda nätverksproblem som kan leda till att API-förfrågningar anländer i fel ordning, genom att tillhandahålla en kort tidsram (1 sekund, 10 sekunder, osv.) under vilken API-förfrågningar med ogiltigt nonce-värde (ett nonce-värde som är lägre än ett tidigare använt nonce-värde) inte orsakar ett fel på grund av ogiltigt nonce-värde.
IP-vitlistor är en säkerhetsfunktion som begränsar användningen av API-nycklar till specifika IP-adresser på klientsidan.
Nyckelns utgångsdatum kan användas för att skapa en API-nyckel som endast fungerar under en specifik tidsperiod, till exempel en nyckel som endast är giltig i 1 vecka.
Frågans startdatum/-tid/slutdatum/-tid är en inställning som begränsar förfrågningar om historiska kontodata till en specifik tidsram, till exempel en nyckel som kan hämta handelshistorik från detta år, men inte från tidigare år.
När API-nyckelinställningarna har konfigurerats korrekt kan du skapa den nya API-nyckeln genom att klicka på knappen Generera nyckel.
VIKTIGT: API-nyckeln, den privata nyckeln och QR-koden bör behandlas på samma sätt som ditt användarnamn/lösenord. Spara dem i en lösenordshanterare om du behöver komma åt dem igen senare. Spara dem inte i okrypterat format!
API-nycklar består av ett offentligt och ett privat nyckelpar, som båda måste tillhandahållas till API-klientprogramvaran.
API-nycklar kan tillhandahållas på olika sätt, till exempel:
Nyckelparet kan kopieras och klistras in i textformat direkt i API-klientkoden. Exempel: Metoden som används av vår PHP API-klient.
Nyckelparet kan kopieras och klistras in i textfiler som API-klienten kan komma åt. Exempel: Metoden som används av vår API-klient för kommandoraden.
Obs: Den privata nyckeln kallas även API-hemlighet (eller hemlig nyckel) av vissa API-klientprogramvaror.
API-nycklar ger redan ett säkert sätt att autentisera API-åtkomst till ett Kraken-konto, men säkerheten kan förbättras ytterligare genom att lägga till tvåfaktorsautentisering (2FA).
2FA för API-nyckel kan läggas till en befintlig API-nyckel via säkerhetssidan och kan använda antingen ett statiskt lösenord eller Google Authenticator.
Obs! Tillägg av 2FA till en API-nyckel kräver också att API-klienten har stöd för 2FA (tillhandahåller 2FA-data för varje anrop till de privata API-metoderna), annars returneras ett oväntat fel istället för önskade API-utdata.
Läs mer om hur 2FA för API-nycklar fungerar här.