Przejdź do głównej zawartości
PlaidCloud

Ogólne połączenie REST

Ogólne połączenie REST łączy PlaidCloud z dowolną usługą HTTP/REST, która nie ma dedykowanego konektora. Obsługuje typowe wzorce uwierzytelniania (None, Basic, API Key, token okaziciela, OAuth 2.0), domyślne nagłówki żądań, szczegółową obsługę przekierowań i transportu oraz wbudowany w formularz tester żądań.

Konwertery, takie jak importer Savant, mogą tworzyć połączenia REST przechowujące zaszyfrowane wartości tajne. Konwertowane przez nie kroki używają tych wartości w czasie uruchomienia.

Konfiguracja

Dział zatytułowany „Konfiguracja”

Formularz ma cztery karty.

Szczegóły połączenia

Dział zatytułowany „Szczegóły połączenia”
Pole Typ Opis
Nazwa połączenia Tekst Wyświetlana nazwa tego połączenia.
Notatka Tekst (wielowierszowy) Opcjonalne uwagi dotyczące połączenia.
Host lub adres IP Tekst Bazowy host, do którego kierowane są żądania.
Aktywne (zezwól na dostęp) Przełącznik Określa, czy połączenie jest włączone. Wyłącz, aby wstrzymać je bez usuwania.
Typ uwierzytelniania Lista wyboru None, Basic, API Key, Bearer Token, OAuth 2.0, Azure Cosmos DB (Master Key) lub Azure Cosmos DB (Microsoft Entra ID). Wybranie typu włącza odpowiednią grupę na karcie Uwierzytelnianie.
Model zabezpieczeń Lista wyboru Kto może korzystać z połączenia — Prywatne, Wybrani członkowie, Wybrane grupy zabezpieczeń lub Wszyscy członkowie obszaru roboczego.

Ustawienia połączenia

Dział zatytułowany „Ustawienia połączenia”
Ustawienie Wartość domyślna Opis
Włącz weryfikację certyfikatów SSL Wył. Weryfikuje certyfikaty SSL podczas wysyłania żądania. Niepowodzenie weryfikacji przerywa żądanie.
Automatycznie podążaj za przekierowaniami Wł. Traktuje odpowiedzi HTTP 3xx jako przekierowania i podąża za nimi.
Zachowaj oryginalną metodę HTTP Wył. Przekierowuje z użyciem oryginalnej metody HTTP zamiast domyślnego przekierowania metodą GET.
Zachowaj nagłówek Authorization Wył. Zachowuje nagłówek autoryzacji w przypadku przekierowania.
Usuń nagłówek referer przy przekierowaniu Wył. Usuwa nagłówek referer w przypadku przekierowania.
Włączono ścisły parser HTTP Wył. Odrzuca odpowiedzi z nieprawidłowymi nagłówkami HTTP.
Koduj adres URL automatycznie Wł. Koduje ścieżkę adresu URL, parametry zapytania i pola uwierzytelniania.
Wyłącz magazyn plików cookie Wył. Nie zapisuje plików cookie tego żądania w magazynie plików cookie i nie wysyła zapisanych plików cookie jako nagłówków.
Użyj zestawu szyfrów serwera podczas uzgadniania Wył. Podczas uzgadniania używa kolejności zestawów szyfrów serwera zamiast kolejności klienta.
Maksymalna liczba przekierowań 10 Limit liczby przekierowań, za którymi należy podążać.

Definicja API

Dział zatytułowany „Definicja API”

Opcjonalnie. Dołącz do połączenia definicję OpenAPI 3.x lub Swagger 2.0 interfejsu API, a każdy krok Żądanie REST korzystający z tego połączenia będzie mógł wyświetlić listę punktów końcowych interfejsu API — z uzupełnionymi metodami, parametrami i treściami żądań — bez ponownego podawania definicji w każdym kroku.

Pole Typ Opis
Definicja Lista wyboru None, OpenAPI / Swagger URL lub OpenAPI / Swagger file.
Adres URL definicji Tekst Adres, pod którym opublikowano specyfikację, na przykład https://api.example.com/openapi.json. Widoczne po wybraniu opcji URL.
Plik definicji Plik Specyfikacja .json lub .yaml przechowywana w Document. Widoczne po wybraniu opcji pliku.

W kroku Żądanie REST wybierz to połączenie, ustaw Źródło punktów końcowych na Z definicji API połączenia, a następnie wybierz Załaduj katalog.

Uwierzytelnianie

Dział zatytułowany „Uwierzytelnianie”

Wyświetlana jest tylko grupa odpowiadająca wybranemu Authentication Type. Przy wartości None karta jest wyłączona.

Podstawowe

Pole Typ Opis
Użytkownik Tekst Nazwa użytkownika uwierzytelniania podstawowego.
Hasło Hasło Hasło uwierzytelniania podstawowego (tylko do zapisu).

Klucz API

Pole Typ Opis
Klucz Tekst Nazwa pola klucza API.
Wartość Tekst Wartość klucza API.

Token okaziciela

Pole Typ Opis
Token Hasło Token okaziciela (tylko do zapisu).

OAuth 2.0

Pole Typ Opis
Dodaj dane uwierzytelniania do Lista wyboru Wysyła dane uwierzytelniania w Request Headers lub w Request URL.
Prefiks nagłówka Tekst Prefiks wartości nagłówka autoryzacji (domyślnie Bearer).
Adres URL uwierzytelniania Tekst Punkt końcowy autoryzacji.
Adres URL tokenu dostępu Tekst Punkt końcowy tokenu.
Identyfikator klienta Tekst Identyfikator klienta OAuth.
Klucz tajny klienta Tekst Klucz tajny klienta OAuth.
Adres URL tokenu odświeżania Tekst Punkt końcowy używany do odświeżania tokenu.
Początkowy token odświeżania Tekst Wstępny token odświeżania używany przy pierwszej wymianie.
Dodatkowe parametry żądania tokenu Tabela Dodatkowe parametry treści wysyłane w żądaniach tokenu (Enabled, Name, Value, Description).
Dodatkowe nagłówki żądania tokenu Tabela Dodatkowe nagłówki wysyłane w żądaniach tokenu (Enabled, Name, Value, Description).

Azure Cosmos DB (Klucz główny)

Pole Typ Opis
Klucz główny Hasło Klucz główny konta Cosmos DB (tylko do zapisu). Każde żądanie jest nim podpisywane, zgodnie z wymaganiami interfejsu REST API Cosmos DB.

Azure Cosmos DB (Microsoft Entra ID)

Pole Typ Opis
Adres URL tokenu dostępu Tekst Punkt końcowy tokenu Twojego tenanta, taki jak https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token.
Identyfikator klienta Tekst Identyfikator klienta aplikacji Entra.
Klucz tajny klienta Hasło Klucz tajny klienta aplikacji Entra (tylko do zapisu).

Użyj połączenia Cosmos DB z krokiem Żądanie REST, aby odpytywać dokumenty kontenera i je zapisywać. Ustaw bazowy adres URL połączenia na punkt końcowy konta Cosmos DB.

Domyślne nagłówki

Dział zatytułowany „Domyślne nagłówki”

Tabela nagłówków wysyłanych w każdym żądaniu przez to połączenie. Każdy wiersz ma kolumny Enabled, Header Name, Value i Description. Za pomocą przycisków wiersza możesz dodawać, wstawiać i usuwać nagłówki. Nagłówki te są wysyłane w każdym żądaniu wykonywanym przez połączenie, w tym przy każdej stronie odczytu ze stronicowaniem i każdym żądaniu w rozgałęzieniu dla poszczególnych wierszy; nagłówek ustawiony w pojedynczym kroku ma pierwszeństwo przed nagłówkiem o tej samej nazwie ustawionym tutaj.

Testowanie

Dział zatytułowany „Testowanie”

Wyślij żądanie ad hoc przez zapisane połączenie, aby sprawdzić, czy działa.

Pole Typ Opis
Testowy punkt końcowy Tekst Pełny adres URL do wywołania (na przykład https://example.com/rest/test/validate).
Metoda Lista wyboru GET, PUT, POST, DELETE, HEAD lub OPTIONS.
Treść Kod Treść żądania. Obsługuje tokeny szablonów w stylu Django/Jinja.
Wyślij żądanie testowe Przycisk Wysyła żądanie i wyświetla odpowiedź (lub błąd).

Powiązane

Dział zatytułowany „Powiązane”