Generische REST-Verbindung

Die generische REST-Verbindung verbindet PlaidCloud mit jedem HTTP/REST-Dienst, für den es keinen eigenen Konnektor gibt. Sie unterstützt die gängigen Authentifizierungsmuster (None, Basic, API Key, Bearer-Token, OAuth 2.0), Standard-Header für Anfragen, fein abgestufte Steuerung von Weiterleitungen und Transport sowie einen Anfragetester im Formular.

Konverter wie der Savant-Importer können REST-Verbindungen erstellen, die verschlüsselte geheime Werte enthalten. Die konvertierten Schritte verwenden diese Werte zur Laufzeit.

Konfiguration

Das Formular hat vier Registerkarten.

Verbindungsdetails

Feld	Typ	Beschreibung
Verbindungsname	Text	Anzeigename für diese Verbindung.
Memo	Text (mehrzeilig)	Optionale Notizen zur Verbindung.
Host oder IP-Adresse	Text	Basis-Host, an den die Anfragen gerichtet werden.
Aktiv (Zugriff erlauben)	Schalter	Gibt an, ob die Verbindung aktiviert ist. Deaktivieren Sie sie, um sie zu pausieren, ohne sie zu löschen.
Authentifizierungstyp	Auswahl	`None`, `Basic`, `API Key`, `Bearer Token`, `OAuth 2.0`, `Azure Cosmos DB (Master Key)` oder `Azure Cosmos DB (Microsoft Entra ID)`. Mit der Auswahl eines Typs aktivieren Sie die passende Gruppe auf der Registerkarte Authentifizierung.
Sicherheitsmodell	Auswahl	Wer die Verbindung verwenden darf: Privat, Bestimmte Mitglieder, Bestimmte Sicherheitsgruppen oder Alle Arbeitsbereichsmitglieder.

Verbindungseinstellungen

Einstellung	Standard	Beschreibung
SSL-Zertifikatsprüfung aktivieren	Aus	Überprüft SSL-Zertifikate beim Senden einer Anfrage. Schlägt die Überprüfung fehl, wird die Anfrage abgebrochen.
Weiterleitungen automatisch folgen	Ein	Behandelt HTTP-3xx-Antworten als Weiterleitungen und folgt ihnen.
Ursprüngliche HTTP-Methode beibehalten	Aus	Leitet mit der ursprünglichen HTTP-Methode weiter, statt standardmäßig mit GET weiterzuleiten.
Authorization-Header beibehalten	Aus	Behält den Authorization-Header bei, wenn eine Weiterleitung erfolgt.
Referer-Header bei Weiterleitung entfernen	Aus	Entfernt den Referer-Header, wenn eine Weiterleitung erfolgt.
Strikten HTTP-Parser aktivieren	Aus	Weist Antworten mit ungültigen HTTP-Headern zurück.
URL automatisch codieren	Ein	Codiert den Pfad der URL, die Abfrageparameter und die Authentifizierungsfelder.
Cookie-Speicher deaktivieren	Aus	Speichert die Cookies dieser Anfrage nicht im Cookie-Speicher und sendet gespeicherte Cookies nicht als Header.
Cipher-Suite des Servers beim Handshake verwenden	Aus	Verwendet beim Handshake die Reihenfolge der Cipher-Suites des Servers statt der des Clients.
Maximale Anzahl an Weiterleitungen	10	Obergrenze für die Anzahl der Weiterleitungen, denen gefolgt wird.

API-Definition

Optional. Hängen Sie die OpenAPI-3.x- oder Swagger-2.0-Definition der API an die Verbindung an. Jeder Schritt REST-Anfrage, der sie verwendet, kann dann die Endpunkte der API auflisten, mit ausgefüllten Methoden, Parametern und Anfragetexten, ohne dass die Definition in jedem Schritt erneut angegeben werden muss.

Feld	Typ	Beschreibung
Definition	Auswahl	`None`, `OpenAPI / Swagger URL` oder `OpenAPI / Swagger file`.
Definitions-URL	Text	Adresse, unter der die Spezifikation veröffentlicht ist, zum Beispiel `https://api.example.com/openapi.json`. Wird angezeigt, wenn Sie URL wählen.
Definitionsdatei	Datei	Eine in Document gespeicherte Spezifikation als `.json`- oder `.yaml`-Datei. Wird angezeigt, wenn Sie Datei wählen.

Wählen Sie in einem Schritt REST-Anfrage diese Verbindung, setzen Sie Endpunktquelle auf Aus der API-Definition der Verbindung und wählen Sie dann Katalog laden.

Authentifizierung

Es wird nur die Gruppe angezeigt, die zum gewählten Authentication Type passt. Bei None ist die Registerkarte deaktiviert.

Basic

Feld	Typ	Beschreibung
Benutzer	Text	Benutzername für die Basic-Authentifizierung.
Passwort	Passwort	Passwort für die Basic-Authentifizierung (nur schreibbar).

API Key

Feld	Typ	Beschreibung
Schlüssel	Text	Feldname des API-Schlüssels.
Wert	Text	Wert des API-Schlüssels.

Bearer Token

Feld	Typ	Beschreibung
Token	Passwort	Bearer-Token (nur schreibbar).

OAuth 2.0

Feld	Typ	Beschreibung
Authentifizierungsdaten hinzufügen zu	Auswahl	Sendet die Authentifizierungsdaten in den `Request Headers` oder in der `Request URL`.
Header-Präfix	Text	Präfix für den Wert des Authorization-Headers (Standard: `Bearer`).
Authentifizierungs-URL	Text	Autorisierungsendpunkt.
Zugriffstoken-URL	Text	Token-Endpunkt.
Client-ID	Text	OAuth-Client-Kennung.
Client-Secret	Text	OAuth-Client-Secret.
Refresh-Token-URL	Text	Endpunkt, über den das Token aktualisiert wird.
Ursprüngliches Refresh-Token	Text	Initiales Refresh-Token für den ersten Austausch.
Zusätzliche Parameter der Token-Anfrage	Tabelle	Zusätzliche Body-Parameter, die bei Token-Anfragen gesendet werden (Aktiviert, Name, Wert, Beschreibung).
Zusätzliche Header der Token-Anfrage	Tabelle	Zusätzliche Header, die bei Token-Anfragen gesendet werden (Aktiviert, Name, Wert, Beschreibung).

Azure Cosmos DB (Hauptschlüssel)

Feld	Typ	Beschreibung
Hauptschlüssel	Passwort	Der Hauptschlüssel des Cosmos-DB-Kontos (nur schreibbar). Jede Anfrage wird damit signiert, wie es die Cosmos-DB-REST-API verlangt.

Azure Cosmos DB (Microsoft Entra ID)

Feld	Typ	Beschreibung
Zugriffstoken-URL	Text	Der Token-Endpunkt Ihres Mandanten, etwa `https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token`.
Client-ID	Text	Die Client-ID der Entra-Anwendung.
Client-Secret	Passwort	Das Client-Secret der Entra-Anwendung (nur schreibbar).

Verwenden Sie eine Cosmos-DB-Verbindung mit dem Schritt REST-Anfrage, um die Dokumente eines Containers abzufragen und zu schreiben. Setzen Sie die Basis-URL der Verbindung auf den Endpunkt des Cosmos-DB-Kontos.

Standard-Header

Eine Tabelle mit Headern, die bei jeder Anfrage über diese Verbindung gesendet werden. Jede Zeile hat Enabled, Header Name, Value und Description. Mit den Zeilenschaltflächen fügen Sie Header hinzu oder ein und löschen sie. Diese Header werden bei jeder Anfrage der Verbindung gesendet, einschließlich jeder Seite einer paginierten Leseanfrage und jeder Anfrage in einer zeilenweisen Auffächerung. Ein Header, der in einem einzelnen Schritt gesetzt ist, hat Vorrang vor einem gleichnamigen Header hier.

Test

Senden Sie eine Ad-hoc-Anfrage über die gespeicherte Verbindung, um zu prüfen, ob sie funktioniert.

Feld	Typ	Beschreibung
Test-Endpunkt	Text	Vollständige URL, die aufgerufen wird (zum Beispiel `https://example.com/rest/test/validate`).
Methode	Auswahl	`GET`, `PUT`, `POST`, `DELETE`, `HEAD` oder `OPTIONS`.
Payload	Code	Anfragetext. Unterstützt Template-Token im Django-/Jinja-Stil.
Testanfrage senden	Schaltfläche	Sendet die Anfrage und zeigt die Antwort (oder den Fehler) an.