Skip to main content

CallRest

Aktualizacja

Opis

Wywołuje REST API określone w ustawieniach systemowych i zwraca JSON.

Ta funkcja wywołuje REST API określone w ustawieniach systemowych i zwraca JSON. UWAGA: przekazywanie parametrów odbywa się inline w wywołaniu funkcji (zobacz przykłady) lub bezpośrednio w definicji API w ustawieniach systemowych. Przekazywanie inline wymaga również określenia placeholderów dla parametrów w ustawieniach systemowych.

Konfigurację potrzebną do działania tej funkcji opisuje artykuł Konfiguracja ustawień systemowych dla CallRest.

Składnia

CallRest("API Name", "Method Name")

Wywołuje określone API i metodę bez dodatkowych parametrów.

CallRest("API Name", "Method Name", "Parameter")

Wywołuje określone API i metodę z parametrem inline.

Parametry

API Name

  • Typ: String
  • Wymagany: tak

Nazwa API skonfigurowanego w ustawieniach systemowych

Method Name

  • Typ: String
  • Wymagany: tak

Nazwa metody skonfigurowanej do użycia z określonym API w ustawieniach systemowych

Call parameter

  • Typ: String
  • Wymagany: nie

Opcjonalne parametry do przekazania w wywołaniu. Wywołanie metody API musi być odpowiednio zdefiniowane w ustawieniach systemowych (tj. określić placeholder dla tej kolekcji parametrów), aby działało. W wywołaniu CallRest() można przekazać wiele kolejnych parametrów.

Zwracana wartość

  • Typ: String

Zwraca odpowiedź JSON z wywołania API.

Przykłady

Podstawowe wywołanie API

Wywołuje metodę TestMethod API TestAPI zdefiniowaną w ustawieniach systemowych i zapisuje wynik JSON w zmiennej 'json’.

      json = CallRest("TestAPI", "TestMethod")

Oczekiwany efekt: Odpowiedź JSON z API.

Przekazywanie parametrów inline

Wywołuje metodę TestMethod API TestAPI, przekazując pole formularza jako parametr, i zapisuje wynik JSON w zmiennej 'json’.

      json = CallRest("TestAPI", "TestMethod", [FormField])

Oczekiwany efekt: Odpowiedź JSON z zastosowanym parametrem pola formularza.

Parametr zmiennej skryptu

Wywołuje metodę TestMethod API TestAPI, przekazując zmienną skryptu jako parametr, i zapisuje wynik JSON w zmiennej 'json’.

      json = CallRest("TestAPI", "TestMethod", scriptVariable)

Oczekiwany efekt: Odpowiedź JSON z zastosowanym parametrem zmiennej skryptu.

Parametr wartości inline

Wywołuje metodę TestMethod API TestAPI, przekazując wartość inline jako parametr, i zapisuje wynik JSON w zmiennej 'json’.

      json = CallRest("TestAPI", "TestMethod", "inlineValue")

Oczekiwany efekt: Odpowiedź JSON z zastosowaną wartością inline.

Wiele parametrów

Wywołuje metodę TestMethod API TestAPI, przekazując wiele parametrów, i zapisuje wynik JSON w zmiennej 'json’.

      json = CallRest("TestAPI", "TestMethod", "inlineValue", [FormField], scriptVariable)

Oczekiwany efekt: Odpowiedź JSON z zastosowanymi wszystkimi parametrami.

Przypadki użycia

Pobieranie danych z zewnętrznych API

Użyj CallRest, aby pobrać dane z zewnętrznych API i przetworzyć odpowiedź JSON.

Integracja usług zewnętrznych

Zintegruj usługi zewnętrzne, wywołując ich REST API za pomocą CallRest.

Dynamiczne przekazywanie parametrów

Przekazuj dynamiczne parametry do wywołań API na podstawie danych wejściowych użytkownika lub zmiennych skryptu.

Dobre praktyki

  • Upewnij się, że API i metoda są poprawnie skonfigurowane w ustawieniach systemowych.
  • Używaj placeholderów w konfiguracji API dla parametrów inline.
  • Waliduj odpowiedź API, aby obsłużyć błędy w sposób kontrolowany.

Typowe błędy

Przekazywanie parametrów bez definiowania placeholderów w konfiguracji API.

Skutek: Wywołanie API kończy się niepowodzeniem z powodu braku mapowania parametrów.

Rozwiazanie: Zdefiniuj placeholdery dla parametrów w konfiguracji API.

Używanie nieobsługiwanych typów treści.

Skutek: Wywołanie API kończy się niepowodzeniem z błędem nieobsługiwanego typu treści.

Rozwiazanie: Upewnij się, że typ treści jest obsługiwany przez funkcję.

Powiązane artykuły