REST API

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

REST API - dokumentacja interfejsu























attribute.group.list

Pobiera informacje o liście grup atrybutów

        array call(string $session_id, "attribute.group.list", array($extended = false, $attributes = false, $groups = null))
    

Parametry wejściowe

  • extended (boolean) - czy zwrócić tylko listę identyfikatorów (false), czy tablicę, której wartościami są tablice asocjacyjne informacji o żądanych obiektach (true)
  • attributes (boolean) - czy pobrać informacje o atrybutach
  • groups (array|null) - tablica identyfikatorów obiektów do pobrania lub null w celu pobrania wszystkich dostępnych obiektów

Wartość zwracana

  • $data jeśli parametr extended ustawiony jest na false, zwracana jest tablica z identyfikatorami dostępnych obiektów (array)
  • $data jeśli parametr extended ustawiony jest na true, zwracana jest tablica, która składa się z tablic asocjacyjnych o strukturze: (array)

Uwagi

  • Wartości tablicy zwróconej przez tą metodę od pewnego klucza mogą przyjmować wartość array('error' ⇒ -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. W celu zapewnienia kompatybilności typów zwracanych obiektów kod błędu jest sygnalizowany przez tablicę asocjacyjną zawierającą klucz 'error'

Rzucane wyjątki SoapFault

  • W przypadku podania identyfikatora nieistniejącego obiektu, rzucany jest wyjątek

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) {
    $params = Array(
        "method" => "call",
        "params" => Array($session, "attribute.group.list", 
                Array(true, true,   // extended, attributes
                        Array(1, 2, 3) // id grupy atrybutów
                    )
            )
    );

    // 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) {
            $attributeGroup = (Array)$item;
            
            echo "Id grupy atrybutów: " . $attributeGroup['pres_id'] . "<br>";
            echo "Nazwa grupy: " . $attributeGroup['name'] . "<br>";
            // itp.

            echo "<br>";

            $attributes = (Array)$attributeGroup['attributes'];
            foreach ($attributes as $att) {
                $attribute = (Array)$att;
                echo "Id atrybutu: " . $attribute['attribute_id'] . "<br>";
                echo "Nazwa atrybutu: " . $attribute['name'] . "<br>";

                if ($attribute['type'] == 2) {  // jeśli typ select
                    echo "Opcje:<br>";
                    $options = (Array)$attribute['options'];
                    foreach ($options as $opt) {
                        echo "Wartość: " . $opt . "<br>";
                    }
                }

                echo "<br>";
            }
            
            echo "<hr><br>";
        }
    }
} else {
    echo "Wystąpił błąd logowania";
}

curl_close($c);
?>