REST API

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

REST API - dokumentacja interfejsu























getApplicationLock

Pobiera informacje o blokadzie aplikacji. Blokada aplikacji jest ustawiana na 5 minut. Po tym czasie, każdy administrator odzyska dostęp do zasobów aplikacji.

        boolean getApplicationLock(string session_id)
    

Parametry wejściowe

  • session_id (string) - identyfikator sesji użytkownika

Wartość zwracana

  • status operacji: (array)

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];
    }
}

$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" => "getApplicationLock",
        "params" => Array($session)
    );

    // 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 {
        if (!empty($result)) {
            echo "Informacje o blokadzie aplikacji:<br>";
            echo "Id użytkownika: " . $result['user_id'] . "<br>";
            echo "Wiadomość: " . $result['message'] . "<br>";
            echo "Ostatnia aktualizacja blokady: " . date("d-m-Y h:i:s", $result['date']) . "<br>";
            echo "Stan blokady: " . $result['locked'] . "<br>";
        } else {
            echo "Brak blokadyy aplikacji";
        }
    }
} else {
    echo "Wystąpił błąd logowania";
}

curl_close($c);
?>