REST API

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

REST API - dokumentacja interfejsu























shipping.info

Pobiera informacje o metodzie dostawy

        array call(string $session_id, "shipping.info", array($id, $ranges = false, $payments = false, $gauges = false, $translations = false))
    

Parametry wejściowe

  • id
  • ranges (boolean) - czy zwrócić dodatkowo informacje o przedziałach wagowych/cenowych
  • payments (boolean) - czy zwrócić dodatkowo informacje o dowiązanych metodach płatności
  • gauges (boolean) - czy zwrócić dodatkowe informacje o dowiązanych gabarytach
  • translations (boolean) - czy zwrócić dodatkowe informacje o translacjach dostawy

Wartość zwracana

  • tablica asocjacyjna z informacjami o metodzie dostawy. \\ Zwracana tablica ma strukturę: (array)

Rzucane wyjątki SoapFault

  • W przypadku braku dostępu do odczytu dla modułu 'konfiguracja', wyrzucany jest wyjątek z komunikatem **Access denied**
  • W przypadku próby pobranie informacji o nieistniejącej metodzie dostawy, wyrzucany jest wyjątek z komunikatem **Object 'shipping' identified as id: '{$id}' does not exist**

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, "shipping.info", 
                Array(7, true, true) // id dostawy, przedziały cenowe, płatności
            )
    );

    // 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 metody dostawy: " . $result['shipping_id'] . "<br>";
        echo "Nazwa: " . $result['name'] . "<br>";
        // itp.
        
        echo "<br>Przedziały wagowe/cenowe:<br>";
        $ranges = (Array)$result['ranges'];
        foreach ($ranges as $r) {
            $range = (Array)$r;
            echo "Od: " . $range['from'] . ", ";
            echo "do: " . $range['to'] . ", ";
            echo "cena: " . $range['price'] . "<br>";
            // itp.
        }
        
        echo "<br>Płatności:<br>";
        $payments = (Array)$result['payments'];
        foreach ($payments as $paymentId) {
            echo "Id płatności: " . $paymentId . "<br>";
        }
    }
} else {
    echo "Wystąpił błąd logowania";
}

curl_close($c);
?>