REST API

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

REST API - dokumentacja interfejsu























attribute.group.info

Pobiera informacje o grupie atrybutów

        array call(string $session_id, "attribute.group.info", array($id, $attributes = false))
    

Parametry wejściowe

  • id (int) - identyfikator grupy atrybutów
  • attributes (boolean) - czy pobrać informacje o atrybutach

Wartość zwracana

  • $data tablica asocjacyjna z danymi obiektu o strukturze: (array)

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.info", 
                Array(1, true)
                    // id grupy atrybutów, atrybuty
            ) 
    );

    // 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 {
        echo "Id grupy atrybutów: " . $result['pres_id'] . "<br>";
        echo "Nazwa grupy: " . $result['name'] . "<br>";
        // itp.
        
        echo "<br>";
        
        $attributes = (Array)$result['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>";
        }
    }
} else {
    echo "Wystąpił błąd logowania";
}

curl_close($c);
?>