Hívások és visszatérési értékek (REST API)

Utolsó frissítés: More than 3 months ago

Hívások


Az API végpontjainak eléréséhez HTTP hívásokat kell küldeni a következő URL-re.

https://futures.kraken.com/derivatives/api/v3

Privát végpontok hívásaihoz a következő HTTP fejléceket kell megadni: apiKey és
authent. A nonce belefoglalása a kérésbe opcionális.

Példa

Az alábbiakban egy példa látható a HTTP fejlécek Java-ban történő belefoglalására. A különböző programozási nyelveken írt teljes működő példákért lásd a Példa implementációk szakaszt. String url = "https://futures.kraken.com/derivatives/api/v3/sendOrder";
URL obj = new URL(url);
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
...
con.setRequestProperty("APIKey", apiKey);
con.setRequestProperty("Authent", authent); ahol az apiKey és az authent a korábban leírtak szerint kerül meghatározásra.


Azoknak a végpontoknak a hívásait, amelyek nem változtatják meg a szerver állapotát, requestType
= GET értékkel és a postData URL-ben történő elküldésével kell benyújtani. Azoknak a végpontoknak a hívásait, amelyek megváltoztatják a szerver állapotát, requestType = POST értékkel és a postData URL-ben történő elküldésével kell benyújtani. A 4. szakasz részletezi, hogy melyik requestType-ot kell használni az egyes végpontokhoz.

Visszatérési értékek


Az API visszatérési értékei JSON formátumban vannak. Ha a hívás sikeres volt, a visszatérési érték tartalmazza a kért
információt vagy visszajelzést a kért műveletről. Lásd az Error! Reference source not found. szakaszt az egyes végpontok visszatérési értékeinek leírásáért.

Ha egy hívás sikeres volt, a gyökérstruktúrában lévő result kulcs értéke success lesz.

Privát végpontok hívásaihoz a következő HTTP fejléceket kell megadni: apiKey és
authent.

Példa

Az alábbiakban a sendorder végpont sikeres hívásának visszatérési értéke látható.
{
"result":"success",
"serverTime":"2016-02-25T09:45:53.818Z",
"sendStatus":{
"receivedTime":"2016-02-25T09:45:53.601Z",
"status":"placed",
"order_id":"c18f0c17-9971-40e6-8e5b10df05d422f0"
}
}


Fontos megjegyezni, hogy ha egy hívás result értéke success, az csupán azt jelenti, hogy a kérés sikeresen megérkezett és feldolgozásra került. Ez nem feltétlenül jelenti azt, hogy a kívánt művelet végrehajtásra került. A művelet állapotával kapcsolatos részletek egy status kulcsban kerülnek visszaadásra, ahol alkalmazható.

Példa

Az alábbiakban a sendorder végpont sikeres hívásának visszatérési értéke látható, ahol a kívánt művelet nem került végrehajtásra. {
"result":"success",
"serverTime":"2016-02-25T09:45:53.818Z",
"sendStatus":{
"receivedTime":"2016-02-25T09:45:53.601Z",
"status":"insufficientAvailableFunds"
}
}

További segítségre van szükséged?