Metoda product.files
Pobiera pliki produktu
array call(string $session_id, "product.files", array($id, $locale))
Ta metoda wywoływana jest za pośrednictwem metody call
Parametry wejściowe
- id (int) - - identyfikator produktu
- locale (string) - - kod lokalizacji w formacie language_REGION
Wartość zwracana
- (array) - tablica (wektor) z informacjami o plikach produktu. Wektor składa się z tablic asocjacyjnych o strukturze:
- ['file_id'] (int) - identyfikator zdjęcia
- ['translation_id'] (int) - identyfikator tłumaczenia produktu
- ['active'] (int[0/1]) - czy plik jest aktywny
- ['order'] (int) - kolejność pliku
- ['name'] (string) - nazwa pliku
- ['description'] (string) - opis pliku
- ['file_name'] (string) - unikalna nazwa pliku w systemie
Rzucane wyjątki SoapFault
- W przypadku podania identyfikatora nieistniejącego produktu, rzucany jest wyjątek z komunikatem product identified as id: {$id} does not exist
Istnieje możliwość wystąpienia wyjątku SoapFault w przypadku nieprawidłowego działania modułu aplikacji. (np poprzez modyfikację kodu aplikacji lub poprzez nieoczekiwany błąd po stronie serwera)
Przykład wywołania w PHP
<?php /** * Logowanie do API * * @param resource $c cURL resource handle * @param string $login Login użytkownika * @param string $password Hasło użytkownika * @return string Indentyfikatorr sesji użytkownika */ function login($c, $login, $password) { $params = Array( "method" => "login", "params" => Array($login, $password) ); curl_setopt($c, CURLOPT_POSTFIELDS, "json=" . json_encode($params)); $result = (Array) json_decode(curl_exec($c)); if (isset($result['error'])) { return null; } else { return $result[0]; } } $c = curl_init(); curl_setopt($c, CURLOPT_URL, 'http://shop.example.com/webapi/json/'); curl_setopt($c, CURLOPT_POST, true); curl_setopt($c, CURLOPT_RETURNTRANSFER, 1); // zalogowanie użytkownika i pobranie identyfikatora sesji $session = login($c, "api", "test"); if ($session != null) { $params = Array( "method" => "call", "params" => Array($session, "product.files", Array(61, "pl_PL") // id produktu, locale ) ); // zakodowanie parametrów dla metody POST $postParams = "json=" . json_encode($params); curl_setopt($c, CURLOPT_POSTFIELDS, $postParams); // dekodowanie rezultatu w formacie JSON do tablicy result $data = curl_exec($c); $result = (Array)json_decode($data); // sprawdzenie, czy wystąpił błąd if (isset($result['error'])) { echo "Wystąpił błąd: " . $result['error'] . ", kod: " . $result['code']; } else { foreach ($result as $item) { $img = (Array)$item; echo "Id pliku: " . $img['file_id'] . "<br>"; echo "Nazwa pliku: " . $img['name'] . "<br>"; // itp. echo "<br>"; } } } else { echo "Wystąpił błąd logowania"; } curl_close($c); ?>