Jesteś tutaj: Dokumentacja Sklepu » webapi » category.list.create

Metoda category.list.create

Tworzy listę kategorii

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

Ta metoda wywoływana jest za pośrednictwem metody call

Parametry wejściowe

list (array) - - lista tablic asocjacyjnych zawierających dane kategorii o strukturze:
- ['translations'] (array) - tablica asocjacyjna zawierająca informacje tłumaczeniach kategorii
  - ['pl_PL'] (array) - tablica asocjacyjna zawierająca informacje o tłumaczeniu w przykładowym języku
    - ['name'] (string) - nazwa kategorii
    - ['description'] (string) - opis kategorii
    - ['active'] (int[0/1]) - aktywność kategorii
    - ['seo_title'] (string) - tytuł wyświetlany w tagu <title>
    - ['seo_description'] (string) - opis wyświetlany w tagu meta description
    - ['seo_keywords'] (string) - opis wyświetlany w tagu meta keywords
- ['order'] (int) - priorytet brany pod uwagę podczas sortowania listy kategorii
- ['parent_id'] (int) - identyfikator kategorii rodzica lub 0 jeśli tworzona kategoria ma być kategorią główną

Wartość zwracana

(array) - tablica zawierająca dodatnie identyfikatory dodanych obiektów lub kody błędów:
- 0 - operacja się nie udała
- -1 - podane dane są nieprawidłowe i nie spełniają wymagań walidacji
- -2 - operacja się nie udała - zabrakło czasu na zrealizowanie operacji

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 kategorii w formie tablicy, rzucany jest wyjątek Invalid data container

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];
    }
}
 
$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) {
    $category1 = Array(        
        "category_id" => null,
        "parent_id" => 0,
        "order" => 1,
        "translations" => Array(
            "pl_PL" => Array(
                "name" => "Kategoria testowa 1",
                "description" => "Kategoria testowa 1",
                "active" => 1,
                "seo_title" => "",
                "seo_description" => "",
                "seo_keywords" => "kategoria1, test, api",
            ),
        ),
    );
 
    $category2 = Array(        
        "category_id" => null,
        "parent_id" => 0,
        "order" => 2,
        "translations" => Array(
            "pl_PL" => Array(
                "name" => "Kategoria testowa 2",
                "description" => "Kategoria testowa 2",
                "active" => 1,
                "seo_title" => "",
                "seo_description" => "",
                "seo_keywords" => "kategoria2, test, api",
            ),
        ),
    );
 
    $categories = Array(
        $category1, 
        $category2
    );
 
    $params = Array(
        "method" => "call",
        "params" => Array($session, "category.list.create", Array($categories))
    );
 
    // 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>";
            } else if ($r == -1) {
                echo "Podane dane są nieprawidłowe i nie spełniają wymagań walidacji" . "<br>";
            } else if ($r == -2) {
                echo "Operacja się nie udała - zabrakło czasu na zrealizowanie operacji" . "<br>";
            }  else {
                echo "Kategoria została dodana, id: " . $r . "<br>";
            }
        }
    }
} else {
    echo "Wystąpił błąd logowania";
}
 
curl_close($c);
?>

Dokumentacja techniczna

Metoda category.list.create

Parametry wejściowe

Wartość zwracana

Rzucane wyjątki SoapFault

Przykład wywołania w PHP