Skip to main content

So verwenden Sie Postman

Sie können Postman nutzen, um Server API V3 zu testen.

Voraussetzungen:

  • Postman muss installiert sein. Postman ist erhältlich unter go.postman.co/home .

  • Sie müssen über einen API-Zugriffsschlüssel und einen API-Geheimschlüssel verfügen, um Server API in Postman testen zu können. Weitere Informationen finden Sie auf der Hilfeseite Benutzerrollen und -berechtigungen .

API zu Postman hinzufügen

Um Server API zu testen, importieren Sie es in Postman.

  • Sie erhalten zunächst einen Link, den Sie anschließend zum Importieren von Server API V3 verwenden. Um auf den Link zuzugreifen, rufen Sie die Server-Benutzeroberfläche auf, wählen Sie das Fragezeichensymbol in der oberen rechten Ecke aus und wählen Sie dann  API-Dokumentation . Dadurch gelangen Sie zur API V3 Swagger-Seite.

    D864A4F19A7E2F0B01BD1B2F6D96039F.png

  • Bitte kopieren Sie die Adresse der API-Dokumentation, die Sie auf der Swagger-Seite finden.

    Note the address of the API documentation you find on the Swagger page. 

  1. Gehen Sie in Postman zu  Sammlungen und wählen Sie dann die Option  Importieren aus.

    Import API to Postman using a link.

  2. Wählen Sie  Link aus und geben Sie die Server API-URL ein, die Sie in Schritt 2 kopiert haben. Wählen Sie anschließend  Weiter aus. E57CB8F28A077B7BE4FBB42086B0BF1F.png

  3. Nun können Sie Alteryx Server API V3 unter der Registerkarte  Sammlungen sehen.

    5289017C498626BCC472ED477FAAB963.png

Autorisierung einrichten

Um Ihre Anfragen senden zu können, müssen Sie die Autorisierung in Postman einrichten.

  • Navigieren Sie zu Collections und wählen Sie  Alteryx Server API V3 aus.

  • Wählen Sie in der Registerkarte Auth die Option OAuth 2.0 als Typ aus.

    4C6D43513F891F48BA15BE378F5169DC.png

  • Richten Sie das aktuelle Token wie folgt ein:

    AD273A073BE2399E360B94B3F9EB79C6.png

  1. Richten Sie im Abschnitt  Neues Token konfigurieren  Folgendes ein:

    1. Wählen Sie optional einen Tokennamen .

    2. Unter Berechtigungsart  wählen Sie nun  Client-Anmeldeinformationen aus.

    3. Unter Zugriffstoken-URL geben Sie den Endpunkt für den Authentifizierungsserver ein. Um den Endpunkt ausfindig zu machen, gehen Sie zu Swagger und suchen Sie nach der Token-URL . Weitere Informationen finden Sie im Abschnitt Authentifizierung auf der Hilfeseite API-Konfiguration und -Autorisierung .

      Find the Token URL in Swagger.

      Beispiel für die endgültige Token-Konfiguration:

      How the API authorization looks like in Postman.

    4. Wählen Sie unter  Client-ID den  API-Zugriffsschlüssel , den Sie unter „Mein Profil“ auf der Server-Benutzeroberfläche finden.

    5. Wählen Sie unter  Client-Geheimnis den API-Geheimschlüssel , den Sie unter „Mein Profil“ auf der Server-Benutzeroberfläche finden.

    6. Wählen Sie unter  Client-Anmeldeinformationen die Option Als Basic Auth-Header senden aus.

  2. Wählen Sie  Neues Zugriffstoken abrufen aus.

Einrichten der Umgebung

Vergessen Sie nicht, die gleichen Werte für die  Umgebung  einzurichten.

  1. Navigieren Sie zum Augensymbol in der oberen rechten Ecke und wählen Sie dann  Hinzufügen für die Umgebung aus.

  2. Wählen Sie einen Namen für die Umgebung.

  3. Wählen Sie die gleiche Basis-URL, den gleichen API-Schlüssel und den gleichen API-Geheimschlüssel wie in Schritt 4  des Abschnitts „Autorisierung einrichten“.

  4. Geben Sie die URL für Ihre Umgebung ein. Sie finden diese in den  Alteryx-Systemeinstellungen  als  Basisadresse . Siehe Schritt 4  im Abschnitt „Autorisierung einrichten“.

  5. Wählen Sie Speichern aus.

Anfragen versenden

Sie können Server API in Postman testen, um Ihre Anfragen zu autorisieren, zu versenden oder verschiedene Codetypen Ihrer Anfragen zu untersuchen.

Beispiel

Nehmen wir an, Sie möchten eine Liste von Assets abrufen, die ein Benutzer besitzt.

  1. Zunächst müssen Sie die spezifische Benutzer-ID kennen.

    1. Gehen Sie zu  Sammlungen und wählen Sie Alteryx Server API V3 aus.

    2. Wählen Sie  Benutzer und dann  Suche nach Benutzerdatensätzen aus.

    3. Über die Registerkarte  Parameter können Sie die benötigten Parameter auswählen, um in allen Benutzerdatensätzen zu suchen.

    4. Um Ihre Anfrage zu versenden, wählen Sie  Senden aus. Sie erhalten nun eine auf den eingegebenen Parametern basierende Ergebnisliste.

    5. Kopieren Sie die ID des Benutzers, für den Sie eine Liste von Assets abrufen möchten, in diese Ergebnisliste.

  2. Öffnen Sie eine neue Registerkarte, um eine weitere Anfrage zu stellen. Gehen Sie zu  Benutzer und wählen Sie {id} aus.

  3. Wählen Sie  Abrufen einer vollständigen Liste der Assets, die ein Benutzer besitzt aus. Geben Sie nun die Benutzer-ID aus der vorherigen Anfrage ein, um die Liste der Assets für diesen Benutzer zu erhalten.

EF76F0DE8E6C3302DC8217A5E26730F2.png

Anmerkung

Wenn Sie eine Anfrage über Postman versenden, vergessen Sie nicht, diese zu autorisieren. Sie haben zwei Möglichkeiten, Ihre Anfrage zu autorisieren:

  • Wählen Sie unter Typ die Option OAuth2 und anschließend einen Ihrer verfügbaren Token aus.

3E01CCA547A640B4F108491EB7F65ADD.png

  • Wählen Sie unter Typ die Option Auth von übergeordnetem Element übernehmen aus. Die von Ihnen konfigurierte Autorisierung wird nun auf die gesamte Sammlung angewendet.

Authorization of a request using Inherited from parent.

In diesem Abschnitt: