Erste Schritte mit Postman

In diesem Tutorial erläutern wir, was Postman ist und wie Sie es schnell einrichten.

​

Einführung

Postman ist eine Desktop- und Webanwendung, mit der Sie über eine grafische Benutzeroberfläche Anfragen an eine API senden können. Wir empfehlen, Postman mit der X API, der X Ads API und den Labs-endpoints zu verwenden, sowohl zur Erkundung der API-Funktionalitäten als auch zur Fehlerbehebung in Ihrer Anwendung.

Derzeit stehen zwei Postman-Sammlungen zur Verfügung:

X API v2 Collection

X Ads API Collection

​

Voraussetzungen

Bevor Sie mit den Postman‑Sammlungen von X arbeiten, stellen Sie sicher, dass Sie den entsprechenden Zugriff und die erforderlichen Anmeldedaten für das von Ihnen gewählte Tool der X Developer Platform besitzen. Weitere Informationen zum Zugriff finden Sie auf unserer Seite „Erste Schritte“.

Sobald Sie ein Developer-Konto haben, eine Developer-App eingerichtet, einen Satz Authentifizierungs‑Keys und Tokens erhalten haben und Ihre Umgebung so konfiguriert ist, dass Sie Anfragen an die spezifische API stellen können, die Sie verwenden möchten, folgen Sie den untenstehenden Schritten, um zu beginnen.  

​

Erste Schritte mit den Postman-Sammlungen von X

​

Schritt eins: Fügen Sie eine der X Postman-Collections zu Ihrem Konto hinzu

Zwar könnten Sie die spezifischen endpoints, die Sie in Postman verwenden möchten, selbst aufbauen, aber wir haben die ganze Schwerarbeit für Sie erledigt und eine sofort einsatzbereite Collection relevanter APIs erstellt. Klicken Sie einfach auf einen der Links im vorangegangenen Abschnitt „Postman-Collections“, und eine Collection mit allen mit der ausgewählten API verknüpften endpoints wird zu Ihrer Postman-App hinzugefügt. Diese Collections sind auch im Postman API network verfügbar. Jeder endpoint enthält automatisch verfügbare Parameter, Beispielantworten und den Authentifizierungstyp, sodass Sie nur Ihre Zugangsdaten und Parameterwerte hinzufügen müssen, um die Funktionalität zu erkunden.

In diesem Beispiel arbeiten wir mit der X API v2 collection.   

​

Schritt zwei: Fügen Sie Ihre Keys und Tokens als Umgebungsvariablen hinzu

Wenn Sie die Collection zu Ihrer Postman-Instanz hinzufügen, wird automatisch eine Umgebung namens „X API v2“ angelegt, zu der Sie Ihre Keys und Tokens hinzufügen müssen. In diesem Schritt führen wir Sie durch den Prozess, Ihre Keys und Tokens aus Ihrer Developer-App in die „X API v2“-Umgebung zu übernehmen.

Um Ihre Keys und Tokens zur „X API v2“-Umgebung hinzuzufügen, klicken Sie oben rechts in Postman auf die Schaltfläche „manage environments“. Alternativ können Sie oben rechts auf die Schaltfläche für die Einstellungen klicken.

Klicken Sie in der Liste der Umgebungen auf „X API v2“.

Fügen Sie anschließend für alle verschiedenen Keys und Tokens, die Sie über das Apps-Dashboard generiert haben, jeweils eine Variable in die Tabelle ein. Hier ist ein Beispiel, wie Ihre Tabelle aussehen sollte:

VARIABLE	INITIAL VALUE	CURRENT VALUE
consumer_key	QAktM6W6DF6F7XXXXXX	QAktM6W6DF6F7XXXXXX
consumer_secret	AJX560A2Omgwyjr6Mml2esedujnZLHXXXXXX	AJX560A2Omgwyjr6Mml2esedujnZLHXXXXXX
access_token	1995XXXXX-0NGqVhk3s96IX6SgT3H2bbjOPjcyQXXXXXXX	1995XXXXX-0NGqVhk3s96IX6SgT3H2bbjOPjcyQXXXXXXX
token_secret	rHVuh7dgDuJCOGeoe4tndtjKwWiDjBZHLaZXXXXXX	rHVuh7dgDuJCOGeoe4tndtjKwWiDjBZHLaZXXXXXX
bearer_token	AAAAAAAAAAAAAAAAAAAAAL9v6AAAAAAA99t03huuqRYg0mpYAAFRbPR3XXXXXXX	AAAAAAAAAAAAAAAAAAAAAL9v6AAAAAAA99t03huuqRYg0mpYAAFRbPR3XXXXXXX

Beachten Sie, dass die in der obigen Tabelle verwendeten Keys und Tokens frei erfunden sind und in einer Anfrage nicht funktionieren.

Sobald Sie Ihre Zugangsdaten als Variablen hinzugefügt und sichergestellt haben, dass die „X API v2“-Umgebung ausgewählt ist, können Sie Anfragen an die X API v2-Collection senden. Die Autorisierungs-Tabs der einzelnen endpoints sind so konfiguriert, dass sie die Variablen automatisch aus dieser Umgebung übernehmen.

Wenn Sie Postman mit User Access Tokens verwenden möchten, überspringen Sie XXXX zu den zusätzlichen Details, wie dies funktioniert.

​

Schritt drei: Ein endpoint auswählen 

Als Nächstes wählen Sie einen endpoint aus der Sammlung aus und beginnen mit dem Erstellen Ihrer Anfrage. Sie können einen endpoint über die Navigation auf der rechten Seite auswählen. So sieht das aus:

Für dieses Beispiel verwenden wir den endpoint X API v2 > Post Lookup > Single Post. 

​

Schritt vier: Werte im Tab „Params“ hinzufügen

Navigieren Sie als Nächstes zum Tab „Params“. Dort sehen Sie eine Reihe inaktiver Parameter mit Beschreibungen, die erläutern, was der jeweilige Parameter bewirkt, sowie eine Liste aller möglichen Werte, die Sie mit Ihrer Anfrage übergeben können.

In diesem Beispiel aktivieren wir die Abfrageparameter expansions und tweet.fields und fügen die folgenden Werte hinzu:

Key	Value
tweet.fields	created_at,attachments
expansions	author_id

Zusätzlich zu den Abfrageparametern müssen wir die erforderliche Pfadvariable id hinzufügen. Da dieses endpoint Posts zurückgibt, müssen wir als Wert eine gültige Post-ID angeben.

Sie finden die Post-ID, indem Sie zu x.com navigieren, auf einen Post klicken und dann in der URL nachsehen. Die Post-ID der folgenden URL ist beispielsweise 1228393702244134912:

https://x.com/XDevelopers/status/1228393702244134912

Scrollen Sie im Tab „Params“ unter allen Abfrageparametern nach unten, bis der Abschnitt „Path Variables“ angezeigt wird. Dort fügen wir die Post-ID ein, die Sie als Wert für den Schlüssel id verwenden möchten.

Wenn Sie alles aus diesem Schritt korrekt eingegeben haben, sollte der Tab „Params“ wie folgt aussehen:

​

Schritt fünf: Senden Sie Ihre Anfrage und prüfen Sie die Antwort

Sobald in Ihrer Anfrage alles konfiguriert ist, können Sie auf die Schaltfläche „Send“ klicken. 

Wenn alles korrekt konfiguriert wurde, sollten Sie die folgende Payload erhalten:

{
    "data": {
        "author_id": "2244994945",
        "text": "Was hat der Entwickler in seine Valentinstagskarte geschrieben?\n  \nwhile(true) {\n    I = Love(You);  \n}",
        "id": "1228393702244134912",
        "created_at": "2020-02-14T19:00:55.000Z"
    },
    "includes": {
        "users": [
            {
                "username": "XDevelopers",
                "name": "Entwickler",
                "id": "2244994945"
            }
        ]
    }
}

​

Generieren eines User Access Token mit Postman:

​

Verwenden von OAuth 1.0a zum Generieren eines Benutzer-Access Tokens

Sehen Sie sich den dreistufigen Prozess in der OAuth 1.0a Flow Test Collection an.

​

Verwenden von OAuth 2.0 zum Generieren eines Benutzer-Access Tokens

Wenn Sie in Postman ein OAuth 2.0 Benutzer-Access Token generieren möchten, können Sie OAuth 2.0 Access Tokens erzeugen, um sie in Verbindung mit der X API v2 Postman collection zu verwenden.

Klicken Sie in Ihrem Workspace auf die Collection, wechseln Sie zum Tab „Auth“ und setzen Sie den type auf „OAuth 2.0“. Gehen Sie unter der Überschrift „Configure New Token“ zu „Configuration Options“. Dort können Sie den „Grant Type“ auf „Authorization Code (With PKCE)“ ändern.

Aktualisieren Sie Ihre Callback-URL so, dass sie der Callback-URL Ihrer Anwendung entspricht. Zusätzlich sollten Sie die folgenden Parameter aktualisieren:

• Auth URL -  https://x.com/i/oauth2/authorize
• Access Token URL -  https://api.x.com/2/oauth2/token
• Client ID - Ihre OAuth 2.0 Client-ID aus dem Dev Portal
• Client Secret - Falls Sie einen vertraulichen Client verwenden
• Update Scope - Scopes, die den endpoints entsprechen, zu denen Sie eine Verbindung herstellen möchten. Beispiel „tweet.read users.read“
• Ihre Callback-URL (auch als Redirect-URL bekannt). Diese muss mit den Authentifizierungseinstellungen Ihrer App übereinstimmen.
• State - state

Wenn Sie bereit sind, klicken Sie auf „Get New Access Token“, um ein Access Token zu generieren. Wenn ein Dialogfeld angezeigt wird, das besagt, dass etwas schiefgelaufen ist, müssen Sie möglicherweise die Zurück-Taste drücken, um sich anzumelden. Sie müssen Ihre App autorisieren, auf Ihr Konto zuzugreifen, indem Sie im Dialogfeld auf „Authorize app“ klicken.

Nachdem Sie Ihre App autorisiert haben, werden Sie zu Postman zurückgeleitet, wo Sie Ihr Token sehen und die Schaltfläche „Use Token“ auswählen können, um im Namen eines autorisierten Nutzers Anfragen zu stellen.

Sie sind nun bereit, die Postman collection zu verwenden.

​

Wie geht es weiter

Wenn Sie in Postman auf die Schaltfläche „Code“ klicken, können Sie die soeben erstellte Anfrage in eine Sprache Ihrer Wahl wie Python, Node oder Ruby umwandeln, um den Einstieg zu erleichtern. Postman verfügt über ausgezeichnete Dokumentation, die hilfreich sein könnte. Wir haben außerdem Beispielcode auf GitHub, mit dem Sie sich schneller in die endpoints integrieren können.