Server-API-Tool
Verwenden Sie das Server-API-Tool, um mit der Server-API (v1, v2 und v3) zu interagieren, ohne einen komplexen Workflow schreiben zu müssen. Weitere Informationen zu Server-API-Zugriff, Authentifizierung, Endpunkten, Parametern und Versionen finden Sie auf der Seite Server-API-Übersicht.
Tipp
Dieses Tool ist nicht automatisch im Lieferumfang von Alteryx Designer enthalten. Um dieses Tool zu verwenden, laden Sie es vom Alteryx Marketplace herunter.
Das Server-API-Tool ist mit Designer und Serverversion 2021.4 und höher kompatibel. Beachten Sie, dass bestimmte Funktionen des Tools entsprechend Ihrer Serverversion eingeschränkt sein können.
Kompatibel mit Alteryx Multi-threaded Processing (AMP) und der Original-Engine.
Das Server-API-Tool wird derzeit nicht im Nur-DCM-Modus von Data Connection Manager unterstützt.
Für das Server-API-Tool müssen die folgenden Pakete auf Ihrem Rechner installiert sein:
oauthlibrequests_oauthlib
Wenn diese Pakete nicht installiert sind, gilt Folgendes:
Fügen Sie das Server-API-Tool zu Ihrem Workflow-Canvas hinzu und führen Sie den Workflow aus. Das Tool generiert einen Fehler, der Sie auf fehlende Pakete aufmerksam macht.
Navigieren Sie zum Fenster mit den Ergebnissen des Workflows und wählen Sie die Registerkarte Alle (oder die Registerkarte Dateien aus, um die Liste der Elemente einzugrenzen).
Suchen Sie die Meldung „Führen Sie diesen verknüpften Workflow als Admin aus, um fehlende Pakete zu installieren“, und aktivieren Sie die Meldung. Dadurch wird ein neuer Workflow mit einem Python-Tool geöffnet, das für die Installation der erforderlichen Pakete vorkonfiguriert ist. Führen Sie den Workflow aus, um die Installation durchzuführen. Beachten Sie, dass Sie diesen Installations-Workflow als Administrator:in ausführen müssen.
Alternativ können Sie die obigen Schritte replizieren und die Pakete über das Python-Tool installieren. Unter Zusätzliche Paketinstallation erfahren Sie, wie Pakete installiert werden.
Das Server-API-Tool verfügt über 6 Anker:
Eingangsanker (beide sind optional):
A-Eingabeanker (zur Autorisierung): Wenn Sie Werte aus Feldern in der Tool-Konfiguration verwenden möchten, verwenden Sie diesen Anker, um Ihre Autorisierungsinformationen anzugeben. Wählen Sie das Feld aus, das Ihre API-Basis-URL enthält, und ein anderes Feld, das Ihre Autorisierungsinformationen enthält (in der Regel das Feld Autorisierung aus der A-Ausgabe eines vorgelagerten Server-API-Tools). Beachten Sie, dass es sich bei den Autorisierungsinformationen um eine Kombination aus dem Bearer-Präfix und dem Access_Token handelt, die oAuth2.0 generiert, wenn Sie sich erstmalig authentifizieren. Weitere Informationen finden Sie unter Server-API-Konfiguration und -Autorisierung.
D-Eingabeanker (zur Dateneingabe): Wenn Sie Werte aus Feldern in der Tool-Konfiguration verwenden möchten, verwenden Sie diesen Anker, um Parameter für Ihren Endpunkt einzugeben. Beachten Sie, dass bestimmte Endpunkte über erforderliche Parameter verfügen.
Ausgabeanker:
A-Ausgabeanker (authToken): Dieser Anker gibt Ihre Authentifizierungsinformationen aus, sodass diese jederzeit verfügbar sind, wenn Sie mehrere Aufrufe tätigen möchten. Verbinden Sie diesen Ausgabeanker mit dem A-Eingabeanker eines anderen Server-API-Tools, um einen weiteren nachgeschalteten API-Aufruf nahtlos zu reauthentifizieren.
S-Ausgabeanker (Erfolg): Dieser Anker gibt alle API-Aufrufe mit dem Antwortcode „200“ aus. Wir parsen die API-Antworten eine Ebene nach unten* und geben die Felder hier aus. Wenn wir eine Antwort nicht analysieren können, enthält das Ausgabefeld Extrahiert eine Meldung mit dem Grund und wir stellen die Rohdaten in den Ausgabefeldern DownloadData und BinaryData bereit.
F-Ausgabeanker (Fehler): Dieser Anker gibt alle API-Aufrufe aus, die keinen Antwortcode „200“ erhalten.
L-Ausgabeanker (Protokolle): Dieser Anker gibt die Protokollinformationen aus, die sich aus Ihrem API-Aufruf ergeben.
Diese Antwort wird in diesem Beispiel vereinfacht. Das rohe JSON-Beispiel zeigt eine typische JSON-Antwort, gefolgt von einem Beispiel derselben Antwort über das Server-API-Tool.
[
{
"id": "12345",
"dateCreated": "2023-05-02T16:50:05.829Z",
"runCount": 0,
"versions": [
{
"versionId": "67890",
"versionNumber": 1,
"dateCreated": "2023-05-02T16:50:05.829Z",
"details": {
"isAmp": false,
"fileName": "test.yxmd"
}
}
]
},
{
"id": "54321",
"dateCreated": "2023-05-03T10:50:48.681Z",
"runCount": 0,
"versions": [
{
"versionId": "09876",
"versionNumber": 1,
"dateCreated": "2023-05-03T10:50:48.681Z",
"details": {
"isAmp": false,
"fileName": "test2.yxmd"
}
}
]
}
]
Die gleiche Antwort wird wie folgt über das Server-API-Tool formatiert. Beachten Sie, dass das Versionselement in der Antwort des Server-API-Tools in einer Spalte / einem Feld konsolidiert wird.
id | dateCreated | runCount | versions |
|---|---|---|---|
12345 | 2023-05-02T16:50:05.829Z | 0 | [{'versionId': '67890', 'versionNumber': 1, 'dateCreated': '2023-05-02T16:50:05.829Z', 'details': {'isAmp': False, 'fileName': 'test.yxmd'}}] |
54321 | 2023-05-03T10:50:48.681Z | 0 | [{'versionId': '09876', 'versionNumber': 1, 'dateCreated': '2023-05-03T10:50:48.681Z', 'details': {'isAmp': False, 'fileName': 'test2.yxmd'}}] |
Verwenden Sie das Fenster zur Tool-Konfiguration, um alle erforderlichen Felder zur Ausführung Ihres API-Aufrufs zu konfigurieren.
Verwenden Sie den Abschnitt Authentifizierung, um die erforderlichen Authentifizierungsinformationen anzugeben. Weitere Informationen finden Sie unter API-Schlüssel und API-Zugriff sowie Server-API-Konfiguration und -Autorisierung.
Werte aus Feldern verwenden: Standardmäßig deaktiviert. Aktivieren Sie diesen Schalter, um ein eingehendes Feld anzugeben, in dem Ihre Basis-URL und die Informationen zu Ihrem Autorisierungstoken (API-Zugriffsschlüssel und API-Zugriffsgeheimnis) gespeichert werden. Wählen Sie die Felder über die Auswahlmenüs Basis-URL auswählen und Autorisierung auswählen aus. Wenn Sie diese Option verwenden, verwenden wir nur den ersten Datensatz, den Sie als Basis-URL und Authentifizierungstoken angeben.
Sie können Ihre Authentifizierungsinformationen auch direkt über das Tool-Konfigurationsfenster eingeben. Beachten Sie, dass diese Felder ausgeblendet sind, wenn Sie den obigen Schalter Werte aus Feldern verwenden aktivieren.
Basis-URL: Geben Sie die Basis-URL für Ihre Server-API an. Sie können dies über die Server-UI-Konfiguration konfigurieren.
API-Schlüssel: Geben Sie Ihren API-Schlüssel ein.
API-Geheimnis: Geben Sie Ihr API-Geheimnis ein.
Im Abschnitt API-Konfiguration können Sie Ihre Methode auswählen, einen Endpunkt wählen und Parameter für Ihren API-Aufruf angeben.
Methode auswählen: Verwenden Sie dieses Auswahlmenü, um Ihre API-Methode auszuwählen. Zur Auswahl stehen:
GET: Mit der GET-Methode können Sie eine Ressource lesen oder anzeigen. Beispielsweise können Sie mit der GET-Methode auf einem Benutzer-Endpunkt eine Liste von Benutzern:innen lesen oder anzeigen.
POST: Mit der POST-Methode können Sie eine Ressource erstellen. Beispielsweise können Sie mit der POST-Methode auf einem Benutzer-Endpunkt einen neuen Benutzer erstellen.
PUT: Mit der PUT-Methode können Sie eine Ressource aktualisieren. Konkret ersetzt die PUT-Methode die vorhandene Ressource. Beispielsweise können Sie mit der PUT-Methode auf einem Benutzer-Endpunkt aktualisieren, indem Sie vorhandene Benutzerdetails durch die von Ihnen angegebenen Benutzerinformationen ersetzen.
DELETE: Mit der DELETE-Methode können Sie eine Ressource löschen. Beispielsweise können Sie mit der DELETE-Methode auf einem Benutzer-Endpunkt einen vorhandenen Benutzer löschen. Wenn Sie die DELETE-Methode auswählen, wird der Schalter DELETE-Methode bestätigen angezeigt. Sie müssen diesen Schalter aktivieren, um einen Löschvorgang erfolgreich auszuführen.
Endpunkt: Verwenden Sie dieses Auswahlmenü, um Ihren Endpunkt auszuwählen. Die Optionen hängen von der ausgewählten Methode ab. Weitere Informationen zu Server-API-Endpunkten und -Parametern finden Sie unter API-Endpunkte und -Parameter, Zugriff auf Server API V3 und Server V3 API-Objekte.
Eingehende Felder für Parameter verwenden*: Standardmäßig deaktiviert. Aktivieren Sie diesen Schalter, um eingehende Felder als Parameter anzugeben. In den verfügbaren Auswahlmenüs geben Sie das Feld an, das die Parameterinformationen enthält.
Parameterwerte eingeben*: Wenn Sie keine eingehenden Felder für Ihre Parameter verwenden möchten, können Sie die Parameter direkt über die bereitgestellten Felder eingeben.
Endpunktparameter
Beachten Sie, dass die verfügbaren Parameter vom Endpunkt abhängen. Darüber hinaus verfügen einige Endpunkte über erforderliche Parameter, andere nicht. Weitere Informationen zu Server-API-Endpunkten und -Parametern finden Sie unter API-Endpunkte und -Parameter, Zugriff auf Server API V3 und Server V3 API-Objekte.
Nutzlast: Wenn Sie die Nutzlast manuell eingeben möchten, können Sie sie hier direkt im JSON-Format eingeben. Alternativ können Sie den Schalter Eingehende Felder für Parameter verwenden verwenden, um das eingehende Feld anzugeben, das die Nutzlast enthält.
Schemabeispiel: Falls zutreffend, wird das Schemabeispiel mit einer korrekten Struktur für die API-Nutzlast aufgefüllt. Sie können die Schaltfläche Schema in Nutzlast verwenden auswählen, um den allgemeinen Text in die Registerkarte „Nutzlast“ zu kopieren und zu ändern.