REST API

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

REST API - dokumentacja interfejsu























payment.list

Pobiera listę metod płatności

        array call(string $session_id, "payment.list", array($extended = false, $translations = false, $currencies = false, $payments = null))
    

Parametry wejściowe

  • extended (bool) - czy zwrócić tylko listę identyfikatorów metod płatności (**false**), czy tablicę, której wartościami są tablice asocjacyjne informacji o żądanych obiektach (**true**)
  • translations (boolean) - czy zwrócić dodatkowo informacje o tłumaczeniach
  • currencies (boolean) - czy zwrócić dodatkowo informacje o przypisanych walutach
  • payments

Wartość zwracana

  • jeśli parametr **extended** ustawiony jest na **false**, zwracana jest tablica z identyfikatorami dostępnych obiektów. (array)
  • jeśli parametr **extended** ustawiony jest na **true**, zwracana jest tablica (wektor) o długości tablicy podanej jako czwarty parametr metody. Wektor 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 próby pobrania informacji o nieistniejącej metodzie płatności, rzucany jest wyjątek z komunikatem **payment 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, "payment.list", 
                Array(true, true, true, // extended, translations, currencies
                        Array(1, 2, 3) // id 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 {
        foreach ($result as $item) {
            $payment = (Array)$item;
            
            echo "Id płatności: " . $payment['payment_id'] . "<br>";
        
            $translations = (Array)$payment['translations'];
            $translPL = (Array)$translations['pl_PL'];
            echo "Nazwa w języku polskim: " . $translPL['title'] . "<br>";
            // itp.

            echo "Waluty:<br>";
            $payments = (Array)$payment['currencies'];
            foreach ($payments as $currencyId) {
                echo "Id waluty: " . $currencyId . "<br>";
            }
            
            echo "<hr><br>";
        }
    }
} else {
    echo "Wystąpił błąd logowania";
}

curl_close($c);
?>