API-nycklar

API-nycklar ger automatiserade system, handelsbottar, driftskript, rapporteringspipelines och FIX-handelssessioner programmatisk åtkomst till din organisations konton. Den här artikeln beskriver behörighetsmodellen för API-nycklar, hur nycklar kopplas till konton, hur organisationens styrning gäller för nyckelinitierade åtgärder och hur nyckeladministration i sig styrs.

API-nycklar är inte medlemmar med identifieringsinformation. De har sin egen, enklare behörighetsmodell:

Medlem

API-nyckel

Autentisering

Individuell inloggning med 2FA

API-nyckelns identifieringsinformation

Gränssnittsåtkomst

Ja

Nej, endast API

Behörighetsmodell

Arbetsflödesprofil + kontoroller

API-nyckelbehörigheter tillämpas på valda konton

Kontovariationer

Ja, roller kan ge olika behörigheter på olika konton

Nej, nyckelns behörigheter tillämpas enhetligt på alla valda konton

Kan initiera uttags- och överföringsförfrågningar

Ja, när det är tillåtet

Ja, när det är tillåtet

Kan godkänna förfrågningar

Ja, utom sina egna

Aldrig

Administrativa arbetsflöden

Ja, enligt deras arbetsflödesprofil

Aldrig

De två modellerna är avsiktligt separata. Medlemmar tilldelas roller, profiler och kontogranularitet eftersom personer samlar på sig varierande ansvarsområden. Nycklar tilldelas en platt scope-plus-konton-modell eftersom automatisering ska vara avgränsad, enhetlig och lätt att granska på ett ögonblick.

En API-nyckel kombinerar två val: vad den får göra (behörigheter) och var (konton).

Behörigheter

Grupp

Behörighet

Vad den tillåter

Medel

Fråga efter medel

Visa saldon och finansieringsstatus

Sätt in

Generera insättningsadresser och visa insättningshistorik

Ta ut

Initiera uttagsförfrågningar (se "Styrning och API-nycklar")

Avkastning

Allokera och avallokera Earn-produkter

Ordrar

Hämta öppna order

Visa öppna order och aktiva affärer

Hämta stängda order

Visa orderhistorik och genomförda affärer

Skapa och ändra ordrar

Lägg och ändra order

Makulera och stäng order

Makulera öppna order och stäng positioner

Adresser

Lägg till uttagsadress

Initiera förfrågningar om att lägga till godkända adresser

Uppdatera din uttagsadress

Initiera förfrågningar om att ändra godkända adresser

Data

Hämta huvudbok

Visa transaktions- och huvudbokshistorik

Exportera data

Exportera kontodata för rapportering och avstämning

Kontomappning

Varje nyckel mappas till ett eller flera konton, valda när nyckeln skapas och redigerbara i efterhand. Nyckelns behörigheter gäller enhetligt för alla valda konton:

  • En nyckel med Query funds och Create and modify orders på två valda konton kan läsa saldon och handla på båda – och inget mer.
  • En nyckel har inga kontospecifika behörigheter. Behöver din automatisering handla på ett konto men bara läsa ett annat? Använd två nycklar. Det håller varje nyckels påverkansradie tydlig.

FIX-anslutning

Nycklar med orderbehörigheter stöder FIX-anslutning för spothandel tillsammans med REST- och WebSocket-API:erna. En FIX-session har samma behörigheter och kontomappning som den underliggande nyckeln: den handlar enbart på nyckelns valda konton, inom nyckelns behörigheter. Företag med FIX-orderflöde dedikerar vanligtvis en nyckel per session, avgränsad till de konton som deskens handlare använder.

Obs:

WebSocket-handel på andra konton än huvudkontot är ännu inte tillgängligt för API-nycklar – det är för närvarande en funktion enbart för ägare. Automatiserat orderflöde på ytterligare konton bör använda REST eller FIX. Se Tillgänglighet och begränsningar.

Säkerhetsinställningar

Inställning

Beskrivning

Nyckelns utgångsdatum

Valfritt utgångsdatum – efter det slutar nyckeln fungera.

Start- och slutdatum för frågor

Begränsa datafrågor till ett angivet datumintervall

WebSocket-anslutningar

Aktivera eller inaktivera realtidsströmning

Anpassat nonce-fönster

Justering av replay-skydd för högfrekvensanvändning

IP-begränsningar

Begränsa nyckelanvändning till specifika IP-adresser eller CIDR-intervall

Tips:

Ge varje nyckel de snävaste behörigheterna, färsta kontona och striktaste IP-begränsningarna som behövs för att utföra sin uppgift. Separata nycklar per system – en för handelsboten, en för rapportering – håller återkallelse precis och kontrollerad.

Organisationens styrning gäller både vad nycklarna gör och hur de hanteras.

Vad nycklarna gör

Tvåkategoriregeln för medlemmar gäller på samma sätt för nycklar:

  • Direkta åtgärder utförs omedelbart. Handel, Earn, saldofrågor, huvudboksfrågor och dataexporter utförs direkt, inom nyckelns behörigheter och konton.
  • Styrda åtgärder skapar förfrågningar. Ett uttag eller en adressändring som initieras av en nyckel hamnar i samma pipeline som ett från en medlem – arbetsflödets policy avgör om det slutförs direkt eller väntar i godkännandekön för manuell granskning.

En nyckel kan bara initiera styrda förfrågningar. Nycklar kan aldrig godkänna – ansvarsfördelning kräver en mänsklig medlem för varje godkännande, och ett skript kan inte ersätta det omdömet. När policyn för uttagsförfrågningar kräver två godkännanden väntar ett nyckelinitierat uttag på två medlemmar, precis som ett medlemsiniterat uttag.

Bygg automatiseringen kring den asynkroniteten: ett lyckat API-anrop innebär att förfrågan skapades, inte att medlen förflyttades. Spåra förfrågan tills den slutförs och beakta den nuvarande begränsningen att en väntande förfrågan inte reserverar medel – om saldot förändras under granskningen misslyckas den godkända förfrågan och måste skickas in på nytt. Se Håll medlen tillgängliga till godkännande.

Nycklar har heller ingen åtkomst till administrativa arbetsflöden. Att hantera teamåtkomst, API-nycklar, konton, adresser (utöver att initiera adressförfrågningar) och policyer är förbehållet medlemmar.

Hur nycklar hanteras

Att skapa, redigera och återkalla API-nycklar är en styrd åtgärd inom det dedikerade arbetsflödet Hantera API-nycklar, separat från Hantera team och åtkomst. Separationen har två syften:

  • Olika administratörer. Du kan låta en driftsingenjör hantera nycklar utan möjlighet att ändra medlemmars åtkomst, och omvänt.
  • Olika policyer. Nyckelhantering kan ha egna godkännandekrav. Många organisationer kräver ett oberoende godkännande för att skapa eller ändra en nyckel – en ny autentiseringsuppgift är en ny ingång till dina konton – men håller återkallelse snabb.
  1. Gå till API-nycklar och välj Skapa nyckel.
  2. Ge nyckeln ett namn som beskriver dess syfte – vilket system den betjänar och vad den gör – så att dess funktion är tydlig vid granskningar och säkerhetshändelser.
  3. Välj nyckelns behörigheter.
  4. Välj de konton som nyckeln ska ha åtkomst till. Behörigheterna gäller lika för alla valda konton.
  5. Konfigurera säkerhetsinställningar: utgångsdatum, IP-begränsningar och noncefönster.
  6. Granska och bekräfta. Om policyn för Hantera API-nycklar kräver godkännande väntar förfrågan på de nödvändiga godkännandena innan nyckeln utfärdas.
Observera:

Redigering av en nyckels behörigheter eller konton, liksom återkallelse av nyckeln, följer samma godkännandeprocess.

Felsökning

Anropet skapade en uttagsförfrågan som nu hålls kvar för godkännande enligt policyn för Uttagsförfrågningar. Kontrollera sidan Förfrågningar – förfrågan visas där med nyckeln som initiator och väntar på de behövliga godkännandena från medlemmar. Det här är styrningsmodellen i praktiken: automatisering föreslår, människor godkänner.

Om förfrågan godkändes men medlen ändå inte rörde sig: kontrollera om saldot täckte beloppet vid slutförandetidpunkten. En väntande förfrågan reserverar inga medel, vilket innebär att aktivitet under granskningstiden kan göra att en godkänd förfrågan misslyckas. Skicka in förfrågan igen när saldot är tillbaka.

Det felande kontot ingår inte i nyckelns kontomappning. En nyckel kan bara användas för sina valda konton. Redigera nyckeln för att lägga till kontot, och observera att nyckelns fullständiga behörigheter gäller även där – nycklar har ingen kontospecifik variation. Är det för brett, skapa en andra nyckel begränsad till det nya kontot.

En enskild nyckel kan inte ha olika behörigheter per konto. Skapa två nycklar: en handelsnyckel kopplad till konto A och en skrivskyddad nyckel kopplad till konto B. Smalare nycklar är också lättare att granska och säkrare att återkalla.

Arbetsflödet Hantera API-nycklar kräver troligen godkännande och förfrågan väntar fortfarande. Nyckeln utfärdas, och dess hemlighet visas, först när alla nödvändiga godkännanden har samlats in. Kontrollera förfrågans status på sidan Förfrågningar.

Nej. Godkännande kräver alltid en mänsklig medlem. Det här är en systemregel, inte en konfigurerbar policy – det är den som gör godkännande av flera parter meningsfullt när automatisering initierar fondflyttningar.

Behöver du mer hjälp?