Metoda product.image.list.save
Zapisuje listę zdjęć produktów
array call(string $session_id, "product.image.list.save", array($list, $force = false))
Ta metoda wywoływana jest za pośrednictwem metody call
Parametry wejściowe
- list (array) - - tablica, w której wartościami są tablice asocjacyjne z danymi o zdjęciach produktów:
- ['product_id'] (int) - identyfikator produktu
- ['gfx_id'] (int) - identyfikator zdjęcia do aktualizacji. Jeśli nie jest podany, utworzone zostanie nowe zdjęcie
- ['file'] (string) - nazwa pliku graficznego
- ['content'] (string) - zawartość pliku graficznego zakodowana w base64
- ['url'] (string) - jeśli istnieje, zawartość pliku graficznego pobierana jest z podanego adresu url. Jeśli pobranie zawartości pliku się nie powiedzie, zwracany jest kod błędu 0
- ['name'] (string) - opis zdjęcia
- force (boolean) - - czy wymusić aktualizację obiektu mimo istniejącej blokady innego administratora
Wartość zwracana
- (array) - tablica zawierająca dodatni identyfikator dodanego obiektu lub kod błędu:
- 0 - operacja się nie udała
- -1 - podane dane są nieprawidłowe i nie spełniają wymagań walidacji
- -2 - operacja się nie udała - zabrakło czasu na zrealizowanie operacji
Wartości tablicy zwróconej przez tą metodę od pewnego klucza mogą przyjmować wartość -2 - to oznacza, że skrypt po stronie serwera nie miał już czasu na wykonanie żądanych operacji na obiektach (poprzednie iteracje przekroczyły 80% całego dostępnego czasu na wykonanie skryptu). W celu zdobycia oczekiwanych informacji, należy ponowić zapytanie wysyłając tablicę pominiętych obiektów.
Rzucane wyjątki SoapFault
- W przypadku próby dodania zdjęcia do 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) { $image1 = Array( "product_id" => 5, "file" => "zdjecie1.jpg", "content" => null, // można użyć zdjęcia zakodowanego base64 // w tym przypadku podajemy url zdjęcia "url" => "http://farm5.static.flickr.com/4126/5082060862_662c91c04e.jpg", "name" => "Zdjęcie testowe 1", ); $image2 = Array( "product_id" => 5, "file" => "zdjecie2.jpg", "content" => null, // można użyć zdjęcia zakodowanego base64 // w tym przypadku podajemy url zdjęcia "url" => "http://farm5.static.flickr.com/4126/5082060862_662c91c04e.jpg", "name" => "Zdjęcie testowe 2", ); $images = Array( $image1, $image2, ); $params = Array( "method" => "call", "params" => Array($session, "product.image.list.save", Array($images, true)) // zdjęcia, force ); // 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 $r) { if ($r == -2) { echo "Operacja się nie udała - zabrakło czasu na zrealizowanie operacji<br>"; } else if ($r == -1) { echo "Podane dane są nieprawidłowe i nie spełniają wymagań walidacji<br>"; } else if ($r == 0) { echo "Operacja się nie udała<br>"; } else { echo "Id nowego zdjęcia: " . $r . "<br>"; } } } } else { echo "Wystąpił błąd logowania"; } curl_close($c); ?>