API-avaimet

API-avaimet antavat automaattisille järjestelmille, kaupankäyntiboteille, operatiivisille skripteille, raportointiputkistoille ja FIX-kaupankäyntisessioille ohjelmallisen pääsyn organisaatiosi tileihin. Artikkeli käsittelee API-avaimen käyttöoikeusmallia, avainten yhdistämistä tileihin, organisaation hallintomallin soveltamista avainten käynnistämiin toimintoihin sekä avainten hallinnan omia käytäntöjä.

API-avaimet eivät ole tunnistetiedoilla varustettuja jäseniä. Niillä on oma, yksinkertaisempi käyttöoikeusmalli:

Jäsen

API-avain

Todennus

Henkilökohtainen kirjautuminen 2FA:lla

API-avaimen tunnistetiedot

Käyttöliittymäpääsy

Kyllä

Ei, vain API

Käyttöoikeusmalli

Työnkulkuprofiili + tiliroolit

API-avaimen käyttöoikeudet valituille tileille

Tilikohtainen vaihtelu

Kyllä, roolit voivat myöntää eri käyttöoikeuksia eri tileille

Ei, avaimen käyttöoikeudet koskevat yhtenäisesti kaikkia valittuja tilejä

Voi käynnistää nosto- ja siirtopyyntöjä

Kyllä, käyttöoikeuksien salliessa

Kyllä, käyttöoikeuksien salliessa

Voi hyväksyä pyyntöjä

Kyllä, omia lukuun ottamatta

Ei koskaan

Hallinnolliset työnkulut

Kyllä, työnkulkuprofiilin mukaisesti

Ei koskaan

Nämä kaksi mallia on tarkoituksella pidetty erillään. Jäsenet saavat rooleja, profiileja ja tilikohtaista tarkkuutta, koska ihmisille kertyy monenlaisia vastuita. Avaimet toimivat kiinteällä laajuus- ja tilimallilla, koska automaation pitää olla rajattua, yhdenmukaista ja helposti tarkistettavissa yhdellä silmäyksellä.

API-avain yhdistää kaksi valintaa: mitä se voi tehdä (käyttöoikeudet) ja missä (tilit).

Oikeudet

Ryhmä

Oikeus

Mitä se sallii

Varat

Varoihin kohdistuva kysely

Tarkastele saldoja ja rahoituksen tilaa

Talleta

Luo talletusosoitteita ja tarkastele talletushistoriaa

Lunasta

Käynnistä nostopyyntöjä (katso „Hallinto ja API-avaimet“)

Ansaitse

Allokoi ja poista allokointi Earn-tuotteille

Toimeksiannot

Hae avoimia toimeksiantoja

Tarkastele avoimia toimeksiantoja ja aktiivisia kauppoja

Hae suljettuja toimeksiantoja

Tarkastele toimeksiantohistoriaa ja toteutuneita kauppoja

Luo ja muokkaa toimeksiantoja

Jätä ja muokkaa toimeksiantoja

Peruuta ja sulje toimeksiantoja

Peruuta avoimia toimeksiantoja ja sulje positioita

Osoitteet

Lisää nosto-osoite

Luo pyyntöjä sallittujen osoitteiden lisäämiseksi

Päivitä nosto-osoite

Luo pyyntöjä sallittujen osoitteiden muuttamiseksi

Tiedot

Hae kirjanpitotiedot

Tarkastele tapahtuma- ja kirjanpitohistoriaa

Vie tiedot

Vie tilitiedot raportointia ja täsmäytystä varten

Tilikartoitus

Jokainen avain yhdistetään yhteen tai useampaan tiliin. Valinnat tehdään avainta luotaessa, ja niitä voi muokata myöhemmin. Avaimen käyttöoikeudet koskevat kaikkia valittuja tilejä tasapuolisesti:

  • Avain, jolla on Varojen kysely- sekä Toimeksiantojen luonti ja muokkaus -oikeudet kahdelle valitulle tilille, voi lukea saldoja ja käydä kauppaa molemmilla – eikä tehdä mitään muuta.
  • Avaimella ei voi asettaa eri oikeuksia eri tileille. Jos automaation täytyy käydä kauppaa yhdellä tilillä mutta vain lukea toista, käytä kahta avainta. Näin jokaisen avaimen vaikutusalue pysyy selkeänä.

FIX-yhteys

Toimeksiantokäyttöoikeuksilla varustetut avaimet tukevat FIX-yhteyttä Spot-kaupankäyntiin REST- ja WebSocket-rajapintojen rinnalla. FIX-istunnolla on samat käyttöoikeudet ja tilikartoitus kuin sen taustalla olevalla avaimella: se käy kauppaa vain avaimen valituilla tileillä ja avaimen oikeuksien puitteissa. FIX-tilausvirtaa käyttävät yritykset varaavat tyypillisesti yhden avaimen istuntoa kohti, rajattuna kyseisen pöydän käyttämiin tileihin.

Huomautus:

WebSocket-kaupankäynti muilla kuin päätilillä ei ole toistaiseksi käytettävissä API-avaimilla – se on tällä hetkellä ainoastaan omistajan käytössä. Lisätilien automatisoitu tilausvirta on toteutettava REST- tai FIX-rajapinnan kautta. Katso Saatavuus ja rajoitukset.

Tietoturva-asetukset

Asetus

Kuvaus

Avaimen vanhentuminen

Valinnainen päivämäärä, jonka jälkeen avain lakkaa toimimasta

Kyselyn alku- ja loppupäivämäärä

Rajaa datakyselyt tietylle aikavälille

WebSocket-yhteydet

Ota reaaliaikainen suoratoisto käyttöön tai poista se käytöstä

Mukautettu nonce-ikkuna

Replay-suojauksen säätö suuritaajuiseen käyttöön

IP-rajoitukset

Rajaa avaimen käyttö tiettyihin IP-osoitteisiin tai CIDR-alueisiin

Vinkki:

Anna jokaiselle avaimelle vain tarvittavat käyttöoikeudet, minimaalinen määrä tilejä ja tiukimmat mahdolliset IP-rajoitukset. Pidä avaimet erillään järjestelmittäin – yksi kaupankäyntibotille, yksi raportointiin – jotta yksittäinen avain voidaan kumota tarkasti.

Organisaation hallinto koskee sekä avainten toimintaa että niiden hallinnointia.

Avainten toiminta

Jäseniin sovellettava kahden kategorian sääntö koskee avaimia samalla tavalla:

  • Suorat toiminnot suoritetaan välittömästi. Kaupankäynti, Earn, saldokyselyt, kirjanpitokyselyt ja tietojen vienti suoritetaan heti avaimen käyttöoikeuksien ja tilien rajoissa.
  • Hallinnoidut toiminnot luovat pyyntöjä. Avaimen käynnistämä nosto- tai osoitemuutospyyntö siirtyy samaan käsittelyjonoon kuin jäsenen käynnistämä pyyntö: työnkulun käytäntö määrittää, suoritetaanko se välittömästi vai odottaako se hyväksyntäjonossa manuaalista tarkistusta.

Avain voi ainoastaan käynnistää hallinnoituja pyyntöjä. Avaimilla ei ole hyväksymisoikeutta – tehtävien eriyttäminen edellyttää, että jokaisen hyväksynnän tekee ihminen jäsenenä, eikä skripti voi korvata tätä harkintaa. Kun nostopyyntökäytäntö edellyttää kahta hyväksyntää, avaimen käynnistämä nosto odottaa kahden jäsenen hyväksyntää – täsmälleen kuten jäsenen käynnistämäkin pyyntö.

Rakenna automaatio tämän asynkronisuuden ympärille: onnistunut API-kutsu tarkoittaa, että pyyntö luotiin – ei sitä, että varat siirtyivät. Seuraa pyyntöä sen valmistumiseen asti ja huomioi nykyinen rajoitus: odottava pyyntö ei varaa varoja erikseen – jos saldo muuttuu tarkistuksen aikana, hyväksytty pyyntö epäonnistuu ja on lähetettävä uudelleen. Katso Pidä varat saatavilla hyväksyntään asti.

Avaimilla ei myöskään ole pääsyä hallinnollisiin työnkulkuihin. Tiimin käyttöoikeuksien, API-avainten, tilien, osoitteiden (osoitepyyntöjen käynnistämistä lukuun ottamatta) ja käytäntöjen hallinta kuuluu yksinomaan jäsenille.

Avainten hallinnointi

API-avainten luominen, muokkaaminen ja peruuttaminen ovat hallinnoituja toimintoja, jotka kuuluvat erilliseen Hallinnoi API-avaimia -työnkulkuun – erillään Hallinnoi tiimiä ja käyttöoikeuksia -työnkulusta. Erottelulla on merkitystä kahdella tavalla:

  • Eri järjestelmänvalvojat. Voit antaa operaatioinsinöörille oikeuden hallita avaimia ilman mahdollisuutta muuttaa jäsenten käyttöoikeuksia, ja päinvastoin.
  • Eri käytännöt. Avainten hallinnalla voi olla omat hyväksyntävaatimuksensa. Monet organisaatiot edellyttävät itsenäistä hyväksyntää avaimen luomiseen tai muokkaamiseen – jokainen uusi tunniste on uusi pääsyväylä tileillesi. Peruuttaminen pidetään kuitenkin nopeana.
  1. Siirry API-avaimiin ja valitse Luo avain.
  2. Nimeä avain sen käyttötarkoituksen mukaan – järjestelmä, jota se palvelee, ja mitä se tekee – jotta sen tehtävä on selvä katselmusten ja tietoturvatapahtumien yhteydessä.
  3. Valitse avaimen oikeudet.
  4. Valitse tilit, joilla avain toimii. Oikeudet pätevät kaikkiin valittuihin tileihin yhdenmukaisesti.
  5. Määritä tietoturva-asetukset: vanhentumispäivä, IP-rajoitukset, nonce-ikkuna.
  6. Tarkista ja vahvista. Jos API-avainten hallinta -käytäntö edellyttää hyväksyntää, pyyntö odottaa tarvittavat hyväksynnät ennen kuin avain myönnetään.
Varoitus:

Avaimen oikeuksien tai tilien muokkaaminen sekä avaimen peruuttaminen noudattavat samaa hallittua prosessia.

Vianmääritys

Kutsu loi nostopyynnön, ja Nostopyyntö-käytäntö pitää sen hyväksyntää odottavana. Tarkista Pyynnöt-sivu – pyyntö näkyy siellä avaimen aloittamana ja odottaa jäsenten tarvittavia hyväksyntöjä. Hallintomalli toimii tarkoitetulla tavalla: automaatio ehdottaa, ihmiset hyväksyvät.

Jos pyyntö hyväksyttiin, mutta varat eivät silti liikkuneet, tarkista oliko lähdetilin saldo riittävä suoritushetkellä – odottava pyyntö ei varaa varoja, joten käsittelyn aikaiset tapahtumat voivat aiheuttaa hyväksytyn pyynnön epäonnistumisen. Lähetä pyyntö uudelleen, kun saldo on palautunut.

Tili, jolla virhe ilmenee, ei sisälly avaimen tilimääritykseen. Avain toimii vain sille valituilla tileillä. Muokkaa avainta ja lisää tili siihen. Huomaa, että avaimen kaikki oikeudet pätevät myös kyseiseen tiliin, koska avaimilla ei ole tilikohtaista vaihtelua. Jos tämä on liian laajaa, luo toinen avain ja rajaa se uuteen tiliin.

Yhdellä avaimella ei voi asettaa eri oikeuksia eri tileille. Luo kaksi avainta: kaupankäyntiavain, joka on yhdistetty tiliin A, ja vain luku -avain, joka on yhdistetty tiliin B. Suppeammilla avaimilla on myös helpompi auditoida käyttöä ja ne ovat turvallisempia peruuttaa.

API-avainten hallinta -työnkulku edellyttää todennäköisesti hyväksyntää, ja pyyntö on edelleen käsittelyssä. Avain myönnetään ja sen salainen avain näytetään vasta, kun tarvittavat hyväksynnät on saatu. Tarkista pyynnön tila Pyynnöt-sivulta.

Ei. Hyväksyntä edellyttää aina ihmisen, jäsenen, toimia. Tämä on järjestelmäsääntö eikä muokattava käytäntö – se tekee useamman osapuolen hyväksynnästä merkityksellisen silloin, kun automaatio käynnistää varainsiirtoja.

Tarvitsetko lisää apua?