REST API

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

REST API - dokumentacja interfejsu























attribute.list.create

Dodaje listę atrybutów

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

Parametry wejściowe

  • list (array) - tablica, której wartościami są tablice asocjacyjna z danymi obiektów do utworzenia:
    • name (string) - nazwa atrybutu
    • description (string) - opis atrybutu
    • pres_id (int) - identyfikator grupy atrybutów
    • order (int) - priorytet wyświetlania atrybutu
    • type (int[0/1/2]) - typ atrybutu: 0 - pole tekstowe, 1 - pole checkbox, 2 - pole select
    • active (int[0/1]) - aktywność atrybutu
    • default (string) - wartość domyślna atrybutu (w przypadku atrybutu typu checkbox, wartość 0 lub 1)
    • options (array) - tablica dostępnych opcji dla atrybutu typu select, której wartościami są nazwy dostępnych opcji

Wartość zwracana

  • dodatni identyfikator dodanego obiektu lub kod błędu: (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

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) {
    $attribute1 = Array(        
        "pres_id" => 1,
        "name" => "Test dodania atrybutu 1",
        "description" => "Opis atrybutu 1",
        "order" => 1,
        "type" => 2, // typ select
        "active" => 1,
        "default" => "Wartość 2",
        "options" => Array(
            "Wartość 1",
            "Wartość 2",
            "Wartość 3",
        ),
    );
    
    $attribute2 = Array(        
        "pres_id" => 1,
        "name" => "Test dodania atrybutu 2",
        "description" => "Opis atrybutu 2",
        "order" => 1,
        "type" => 2, // typ select
        "active" => 1,
        "default" => "Wartość 2",
        "options" => Array(
            "Wartość 1",
            "Wartość 2",
            "Wartość 3",
        ),
    );
    
    $attributes = Array(
        $attribute1, 
        $attribute2
    );
    
    $params = Array(
        "method" => "call",
        "params" => Array($session, "attribute.list.create", Array($attributes))
    );

    // 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 "Cecha została dodana, id: " . $r . "<br>";
            }
        }
    }
} else {
    echo "Wystąpił błąd logowania";
}

curl_close($c);
?>