REST API

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

REST API - dokumentacja interfejsu























option.group.list.create

Dodaje listę grup cech

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

Parametry wejściowe

  • list (array) - lista tablic asocjacyjnych zawierających dane o strukturze:
    • filters (int[0/1]) - czy wyświetlić w filtrach
    • 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 grupy cech

Wartość zwracana

  • tablica zawierająca dodatnie identyfikatory dodanych obiektów lub kody błędów: (array)

Uwagi

  • 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 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) {
    $optionGroup1 = Array(        
        "translations" => Array(
            "pl_PL" => Array(
                "name" => "Test dodania grupy cech 1",
            ),
        ),
    );
    
    $optionGroup2 = Array(        
        "translations" => Array(
            "pl_PL" => Array(
                "name" => "Test dodania grupy cech 2",
            ),
        ),
    );
    
    $optionsGroups = Array(
        $optionGroup1, 
        $optionGroup2
    );
    
    $params = Array(
        "method" => "call",
        "params" => Array($session, "option.group.list.create", Array($optionsGroups))
    );

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

curl_close($c);
?>