REST API

Aktualna dokumentacja nowoczesnego interfejsu rest api jest dostępna pod adresem https://developers.shoper.pl/

REST API - dokumentacja interfejsu























option.create

Dodaje cechę

        array call(string $session_id, "option.create", array($data))
    

Parametry wejściowe

  • data (array) - tablica asocjacyjna z danymi obiektu o strukturze:
    • group_id (int) - (wymagane) identyfikator grupy cech
    • order (int) - (opcjonalne) numer kolejności w jakiej ustawiane są cechy, domyślnie ustawiana jako wielkość listy + 1
    • type (string) - (opcjonalne) typ pola (file|text|radio|select|checkbox|color), domyślnie select
    • required (int[0|1]) - (opcjonalne) wymagalność, domyślnie 1
    • change_price_type (int[-1|0|1]) - (opcjonalne) zmniejsz cenę o (-1) / nie zmieniaj ceny (0) / zwiększ cenę o (1), domyślnie 0 - dla typów: file, text, checkbox
    • change_price_value (float) - (opcjonalne) wartość zmniejszająca lub zwiększająca cene - dla typów: file, text, checkbox jesli change_price_type != 0
    • percent (int[0|1]) - (opcjonalne) czy zmniejszyć / zwiększyć cenę o procent (1) czy o kwotę (0), domyślnie 0 - dla typów: file, text, checkbox jesli change_price_type != 0
    • filters (int[0|1]) - (opcjonalne) pokazuj w opcjach przeglądania, domyślnie 1 - tylko dla typów: radio, select, paleta kolorów
    • stock (int[0|1]) - (opcjonalne) obsługa magazynu, domyślnie 0 - tylko dla typów: radio, select, paleta kolorów
    • translations (array) - tablica asocjacyjna zawierająca informacje o tłumaczeniach
      • pl_PL (array) - tablica asocjacyjna zawierająca informacje o tłumaczeniu w przykładowym języku
        • name (string) - nazwa cechy
    • values (array) - tablica asocjacyjna zawierająca informacje o wartościach - tylko dla typów: radio, select, paleta kolorów
      • 0 (array) -
        • translations (array) -
        • order (int) - (opcjonalne) numer kolejności w jakiej ustawiane są cechy, domyślnie ustawiana jako wielkość listy + 1
        • change_price_type (int[-1|0|1]) - (opcjonalne) zmniejsz cenę o (-1) / nie zmieniaj ceny (0) / zwiększ cenę o (1), domyślnie 0
        • change_price_value (float) - (opcjonalne) wartość zmniejszająca lub zwiększająca cene, domyślnie 0
        • percent (int[0|1]) - (opcjonalne) czy zmniejszyć / zwiększyć cenę o procent (1) czy o kwotę (0), domyślnie 0
        • color (string) - (opcjonalne) kolor podany w formacie hex lub string "transparent", domyślnie "transparent"

Wartość zwracana

  • dodatni identyfikator dodanego obiektu lub kod błędu: (int)

Rzucane wyjątki SoapFault

  • W przypadku nie podania danych w formie tablicy, rzucany jest wyjątek **Invalid data container**

Uwagi

  • 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];
    }
}

/**
 * Pobranie błędów
 * 
 * @param resource $c cURL resource handle
 * @param string $session Indentyfikatorr sesji użytkownika
 */
function getError($c, $session){
	$params = Array(
        "method" => "call",
        "params" => Array($session, 'internals.validation.errors', null)
    );
    curl_setopt($c, CURLOPT_POSTFIELDS, "json=" . json_encode($params));
    $result = (Array) json_decode(curl_exec($c));
    return $result;
}

$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) {
    $option = Array(        
        "group_id" => 1,
        "translations" => Array(
            "pl_PL" => Array(
                "name" => "Test dodania cechy",
            ),
        ),
    );
    
    $params = Array(
        "method" => "call",
        "params" => Array($session, "option.create", Array($option))
    );

    // 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 {
        if ($result[0] == 0) {
            echo "Operacja się nie udała";
            $err = getError($c, $session);
                foreach($err as $error){
					echo PHP_EOL.$error;
				}
        } else if ($result[0] == -1) {
            echo "Podane dane są nieprawidłowe i nie spełniają wymagań walidacji";
            $err = getError($c, $session);
                foreach($err as $error){
					echo PHP_EOL.$error;
				}
        } else {
            echo "Cecha została dodana, id: " . $result[0];
        }
    }
} else {
    echo "Wystąpił błąd logowania";
}

curl_close($c);
?>