Strict Standards: Declaration of action_plugin_searchtext::register() should be compatible with DokuWiki_Action_Plugin::register($controller) in /lib/plugins/searchtext/action.php on line 14

Warning: Cannot modify header information - headers already sent by (output started at /lib/plugins/searchtext/action.php:14) in /inc/auth.php on line 313

Warning: Cannot modify header information - headers already sent by (output started at /lib/plugins/searchtext/action.php:14) in /inc/actions.php on line 163
webapi:call [Shop Docs]

Dokumentacja techniczna

Jesteś tutaj: Dokumentacja Sklepu » webapi » call

Metoda call

Umożliwia wykonywanie metod udostępnianych przez odpowiednie meduły webapi aplikacji.

mixed call(string session_id, string method_name, array arguments)

Parametry wejściowe

  1. session_id (string) - identyfikator sesji użytkownika
  2. method_name (string) - nazwa wywoływanej metody
  3. arguments (array|null) - Tablica (wektor) wartości przekazywanych jako kolejne argumenty wywoływanej metody.

Wartość zwracana

  1. return_value (mixed|null) - wartość zwracana przez konkretną metodę webapi.
Jeśli wybrana metoda webapi zwraca pustą tablicę, metoda call zwraca wartość null

Rzucane wyjątki SoapFault

  1. W przypadku nieprawidłowego identyfikatora sesji lub nagłego usunięcia użytkownika, rzucany jest wyjątek z komunikatem Permission denied i kodem błędu 2
  2. W przypadku blokady aplikacji przez innego użutkownika, rzucany jest wyjątek z komunikatem Application locked i kodem błędu 3
  3. W przypadku uruchomienia metody, do której administrator nie ma wystarczającego poziomu uprawnień, rzucany jest wyjątek z komunikatem Access denied i kodem błędu 4
  4. W przypadku podania nieprawidłowej nazwy metody, rzucany jest wyjątek z komunikatem Requested function '$function' is not registered
  5. W przypadku złapania wyjątku z używanej metody jest on rzucany jako SoapFault z orginalnym komunikatem i kodem błędu
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" => "call",
        "params" => Array($session, "internals.version", null)
    );
 
    // 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 "Wersja sklepu: " . $result[0];
    }
} else {
    echo "Wystąpił błąd logowania";
}
 
curl_close($c);
?>