API-nøgler

API-nøgler giver automatiserede systemer, handelsbots, driftsscripts, rapporteringspipelines og FIX-handelssessioner programmatisk adgang til din organisations konti. Denne artikel beskriver tilladelsesmodellen for API-nøgler, hvordan nøgler knyttes til konti, hvordan organisationens ledelse gælder for nøgleiniterede operationer, og hvordan administration af nøgler selv er reguleret.

API-nøgler er ikke medlemmer med legitimationsoplysninger. De har deres egen, enklere tilladelsesmodel:

Medlem

API-nøgle

Godkendelse

Individuelt log ind med 2FA

API-nøglens legitimationsoplysninger

Adgang til brugergrænseflade

Ja

Nej, kun API

Tilladelsesmodel

Workflowprofil + kontoroller

API-nøglens tilladelser gælder for valgte konti

Variation pr. konto

Ja, roller kan tildele forskellige tilladelser på tværs af konti

Nej, nøglens tilladelser gælder ensartet for alle valgte konti

Kan starte udbetalings- og overførselsanmodninger

Ja, når det er tilladt

Ja, når det er tilladt

Kan godkende anmodninger

Ja, undtagen egne

Aldrig

Administrative arbejdsgange

Ja, i henhold til deres workflowprofil

Aldrig

De to modeller er bevidst adskilte. Medlemmer tildeles roller, profiler og kontogranularitet, fordi mennesker opbygger varierede ansvarsområder. Nøgler følger en flad model med scope og konti, fordi automatisering bør være afgrænset, ensartet og nem at overskue.

En API-nøgle kombinerer to valg: hvad den må gøre (dens tilladelser) og hvor (dens konti).

Tilladelser

Gruppe

Tilladelse

Hvad den giver adgang til

Midler

Forespørg om midler

Se saldo og finansieringsstatus

Indbetal

Generer indbetalingsadresser og se indbetalingshistorik

Udbetal

Start udbetalingsanmodninger (se “Ledelse og API-nøgler”)

Optjen

Allokere og deallokere Earn-produkter

Ordrer

Forespørg åbne ordrer

Se åbne ordrer og aktive handler

Forespørg lukkede ordrer

Se historiske ordrer og gennemførte handler

Opret og ændr ordrer

Opret og rediger ordrer

Annuller og luk ordrer

Annuller åbne ordrer og luk positioner

Adresser

Tilføj udbetalingsadresse

Start anmodninger om at tilføje hvidlistede adresser

Opdater hæveadresser

Start anmodninger om at ændre hvidlistede adresser

Data

Forespørg hovedbog

Se transaktions- og hovedbogshistorik

Eksportér data

Eksportér kontodata til rapportering og afstemning

Kontotilknytning

Hver nøgle er tilknyttet en eller flere konti, valgt ved oprettelsen og redigerbar efterfølgende. Nøglens tilladelser gælder ensartet for alle valgte konti:

  • En nøgle med Query funds og Create and modify orders på to valgte konti kan læse saldi og handle på begge – og intet andet.
  • En nøgle har ingen pr.-konto-variation. Hvis din automatisering skal handle på én konto, men kun læse en anden, skal du bruge to nøgler. Det gør det let at overskue, hvilke konsekvenser en kompromitteret nøgle kan have.

FIX-forbindelse

Nøgler med ordretilladelser understøtter FIX-forbindelse til spothandel sideløbende med REST- og WebSocket-API'erne. En FIX-session har samme tilladelser og kontotilknytning som den bagvedliggende nøgle: den handler kun på nøglens valgte konti og inden for nøglens tilladelser. Virksomheder med FIX-ordreflow dedikerer typisk én nøgle pr. session, afgrænset til de konti, som det pågældende team handler på.

Bemærk:

WebSocket-handel på andre konti end hovedkontoen er endnu ikke tilgængeligt for API-nøgler – det er foreløbig en funktion forbeholdt ejere. Automatiseret ordreflow på ekstra konti bør bruge REST eller FIX. Se Tilgængelighed og begrænsninger.

Sikkerhedsindstillinger

Indstilling

Beskrivelse

Udløb af nøgle

Valgfri dato, hvorefter nøglen deaktiveres

Start-/slutdato for forespørgsler

Begræns dataforespørgsler til et bestemt datointerval

WebSocket-forbindelser

Aktiver eller deaktiver realtidsstreaming

Brugerdefineret midlertidigt vindue

Juster replay-beskyttelse til højtfrekvent brug

IP-begrænsninger

Begræns nøglens brug til bestemte IP-adresser eller CIDR-intervaller

Tip:

Giv hver nøgle de snævreste tilladelser, færrest konti og strammeste IP-begrænsninger, der stadig lader den udføre sin opgave. Brug separate nøgler pr. system – én til handelsbotten, én til rapportering – og hold tilbagekaldelse præcis og kirurgisk.

Organisationens ledelse gælder for både, hvad nøgler kan gøre, og hvordan de administreres.

Hvad nøgler gør

Tokategorireglen for medlemmer gælder på samme måde for nøgler:

  • Direkte handlinger udføres øjeblikkeligt. Handel, Earn, saldoforespørgsler, hovedbogsforespørgsler og dataeksport gennemføres straks, inden for nøglens tilladelser og konti.
  • Styrede handlinger opretter anmodninger. En udbetaling eller adresseændring igangssat af en nøgle følger samme flow som en igangssat af et medlem: workflowets politik afgør, om den gennemføres straks eller afventer i godkendelseskøen til menneskelig gennemgang.

En nøgle kan kun oprette styrede anmodninger. Nøgler kan aldrig godkende – opgaveadskillelse kræver et menneskeligt medlem ved enhver godkendelse, og et script kan ikke træde i stedet for den vurdering. Når politikken for udbetalingsanmodninger kræver to godkendelser, afventer en nøgle-initieret udbetaling to medlemmer – præcis som en medlem-initieret anmodning ville.

Byg automatisering op omkring denne asynkronicitet: et vellykket API-kald betyder, at anmodningen blev oprettet – ikke at midlerne blev overført. Følg anmodningen, indtil den gennemføres, og vær opmærksom på den aktuelle begrænsning: en afventende anmodning reserverer ikke midler. Hvis saldoen ændrer sig under gennemgangen, mislykkes den godkendte anmodning og skal indsendes på ny. Se Hold midlerne tilgængelige indtil godkendelse.

Nøgler har heller ingen adgang til de administrative workflows. Administration af teamadgang, API-nøgler, konti, adresser (ud over at starte adresseanmodninger) og politikker er forbeholdt medlemmer.

Sådan administreres nøgler

Oprettelse, redigering og tilbagekaldelse af API-nøgler er en styret handling under det dedikerede workflow Administrer API-nøgler, adskilt fra Administrer team og adgang. Adskillelsen har betydning på to måder:

  • Forskellige administratorer. Du kan lade en driftsingeniør administrere nøgler uden nogen mulighed for at ændre medlemmers adgang – og omvendt.
  • Forskellige politikker. Nøgleadministration kan have sine egne godkendelseskrav. Mange organisationer kræver uafhængig godkendelse for at oprette eller ændre en nøgle – en ny legitimation er en ny indgang til dine konti – mens tilbagekaldelse kan ske hurtigt.
  1. Gå til API-nøgler, og vælg Opret nøgle.
  2. Navngiv nøglen efter dens formål – det system den betjener, og hvad den gør – så funktionen er tydelig ved gennemgange og sikkerhedshændelser.
  3. Vælg nøglens tilladelser.
  4. Vælg de konti, nøglen skal bruges på. Tilladelserne gælder ens for dem alle.
  5. Konfigurer sikkerhedsindstillinger: udløb, IP-begrænsninger, nonce-vindue.
  6. Gennemse og bekræft. Kræver politikken for administration af API-nøgler godkendelse, venter anmodningen på de nødvendige godkendelser, før nøglen udstedes.
Advarsel:

Redigering af en nøgles tilladelser eller konti og tilbagekaldelse af en nøgle følger den samme godkendte proces.

Fejlfinding

Kaldet oprettede en udbetalingsanmodning, og politikken for udbetalingsanmodninger afventer godkendelse. Tjek siden Anmodninger – anmodningen vises der med nøglen som initiativtager og afventer de nødvendige medlemsgodkendelser. Det er styringsmodellen, der virker som tilsigtet: automatisering foreslår, mennesker godkender.

Hvis anmodningen blev godkendt, men midlerne alligevel ikke bevægede sig, skal du kontrollere, om kildesaldoen dækkede beløbet på færdiggørelsestidspunktet – en afventende anmodning reserverer ikke midler, så aktivitet under gennemgangen kan få en godkendt anmodning til at mislykkes. Indsend anmodningen igen, når saldoen er tilstrækkelig.

Den fejlende konto er ikke inkluderet i nøglens kontoudvalg. En nøgle virker kun på de valgte konti. Rediger nøglen for at tilføje kontoen – bemærk, at nøglens fulde tilladelsessæt vil gælde der, da nøgler ikke understøtter variation pr. konto. Er det for bredt, kan du oprette en anden nøgle afgrænset til den nye konto.

En enkelt nøgle kan ikke tildele forskellige tilladelser pr. konto. Opret to nøgler: en handelsnøgle tilknyttet konto A og en skrivebeskyttet nøgle tilknyttet konto B. Mere afgrænsede nøgler er også nemmere at auditere og sikrere at tilbagekalde.

Arbejdsgangen Manage API Keys kræver sandsynligvis godkendelse, og anmodningen afventer fortsat. Nøglen udstedes, og den hemmelige nøgle vises, først når de nødvendige godkendelser er indhentet. Tjek anmodningens status på siden Anmodninger.

Nej. Godkendelse kræver altid et menneskeligt Medlem. Dette er en systemregel – ikke en konfigurerbar politik. Det er den, der giver flerpartsgodkendelse mening, når automatisering initierer pengebevægelser.

Har du brug for mere hjælp?