A kliens használata

A kliens megfelelő függvényének meghívásával lehet az adott API erőforrást elérni. Minden hívás a következő struktúrával tér vissza:

array(4) {
  'responseHeaders' =>
  array(6) {
    [0] =>
    string(15) "HTTP/1.1 200 OK"
    [1] =>
    string(35) "Date: Sun, 04 Sep 2016 11:39:48 GMT"
    [2] =>
    string(30) "Server: Apache/2.4.10 (Debian)"
    [3] =>
    string(23) "Cache-Control: no-cache"
    [4] =>
    string(18) "Content-Length: 31"
    [5] =>
    string(30) "Content-Type: application/json"
  }
  'status' =>
  int(200)
  'errorCode' =>
  int(0)
  'response' =>
    ...
}

responseHeaders

• az API szerver által visszaadott HTTP fejlécek

status

• a szerver által visszaadott HTTP státusz kód
• az API erőforrások ezzel a kóddal jelzik, hogy egy hívás sikeres volt-e, vagy sem
• sikertelen authentikáció esetén minden hívás 401-es HTTP státusszal tér vissza

errorCode

• az API hívás során felmerült cUrl hiba kódja. Általában hiba esetén a status mező értéke 0
• lehetséges hibakódok: https://curl.haxx.se/libcurl/c/libcurl-errors.html

response

• az API erőforrás által visszaadott adat, string vagy tömb formájában, a válasz típusától függően