Schnellstart

​

Erste Schritte mit dem Spaces-Such-endpoint

Dieser Schnellstartleitfaden hilft Ihnen, mit Postman Ihre erste Anfrage an den Spaces-Such-endpoint mit einem Satz angegebener fields zu stellen.

Wenn Sie Beispielcode in verschiedenen Programmiersprachen sehen möchten, besuchen Sie bitte unser X API v2 Sample-Code-GitHub-Repository.

Voraussetzungen

Um diese Anleitung abzuschließen, benötigen Sie ein Set von Keys und Tokens, um Ihre Anfrage zu authentifizieren. Sie können diese Keys und Tokens generieren, indem Sie die folgenden Schritte ausführen:

• Registrieren Sie sich für ein Developer-Konto und lassen Sie es genehmigen.
• Erstellen Sie ein Project und eine zugehörige Developer-App im Entwicklerportal.
• Navigieren Sie in Ihrer App zur Seite „Keys and tokens“, um die erforderlichen Zugangsdaten zu generieren. Speichern Sie alle Zugangsdaten an einem sicheren Ort.

​

Schritte zum Erstellen einer Spaces-Suchanfrage

Schritt eins: Beginnen Sie mit einem Tool oder einer Bibliothek

Es gibt verschiedene Tools, Codebeispiele und Bibliotheken, mit denen Sie eine Anfrage an diesen endpoint stellen können. Hier verwenden wir zur Vereinfachung das Tool Postman.

Um die X API v2-Postman-Collection in Ihre Umgebung zu laden, klicken Sie bitte auf die folgende Schaltfläche:

X API v2 zu Postman hinzufügen

Sobald Sie die X API v2-Collection in Postman geladen haben, navigieren Sie zum Ordner Spaces und suchen Sie die Anfrage „Search Spaces“.  

Schritt zwei: Authentifizieren Sie Ihre Anfrage

Um korrekt eine Anfrage an die X API zu stellen, müssen Sie nachweisen, dass Sie berechtigt sind. Zu diesem Zweck erfordert dieser endpoint, dass Sie Ihre Anfrage entweder mit OAuth 2.0 App-Only oder OAuth 2.0 Authorization Code mit PKCE authentifizieren.

Der Einfachheit halber verwenden wir für diese Anfrage OAuth 2.0 App-Only. Sie müssen jedoch eine der anderen Authentifizierungsmethoden nutzen, wenn Sie private metrics oder Spaces eines privaten Nutzers anfordern möchten. 

Um OAuth 2.0 App-Only zu nutzen, müssen Sie Ihre Keys und Tokens hinzufügen, insbesondere den App Access Token (auch bekannt als App-only Bearer Token), in Postman. Wählen Sie dazu oben rechts in Postman die Umgebung „X API v2“ aus und tragen Sie Ihre Keys und Tokens in die Felder „initial value“ und „current value“ ein (über das Augensymbol neben der Umgebungs-Dropdown-Liste).

Diese Variablen werden automatisch im Reiter „Authorization“ der Anfrage übernommen, wenn Sie dies korrekt eingerichtet haben.  

Schritt drei: Eine Suchabfrage erstellen

Dieser endpoint akzeptiert Text als Suchabfrage. Im Gegensatz zu anderen Such-endpoints akzeptiert er keine Operatoren, Gruppierungen oder logischen Operatoren. Für diese Übung verwenden wir „hello“ als einfache Abfrage.

Navigieren Sie in Postman zum Reiter „Params“ und geben Sie diese Nutzer-ID in die Spalte „Value“ des Parameters id ein.

Key	Value
query	hello

Schritt vier: Identifizieren und angeben, welche fields Sie abrufen möchten

Wenn Sie nach Schritt drei auf die Schaltfläche „Send“ klicken, erhalten Sie die ID der Spaces und ihren Status. Dies sind die einzigen Space-Objekt-fields, die standardmäßig in Ihrer Antwort zurückgegeben werden.

Wenn Sie zusätzliche fields erhalten möchten, müssen Sie diese in Ihrer Anfrage mit den Parametern space.fields oder expansions angeben.

Für diese Übung fordern wir drei zusätzliche Sets von fields aus verschiedenen Objekten an:

• Das zusätzliche title-Feld im primären Spaces-Objekt.
• Das vollständige User-Objekt der angegebenen creator ID
• Das zusätzliche user.created_at-Feld im zugehörigen User-Objekt.

Navigieren Sie in Postman zum Reiter „Params“ und fügen Sie das folgende Schlüssel:Wert-Paar zur Tabelle „Query Params“ hinzu:

Key	Value	Returned fields
space.fields	title	creator_id
expansions	creator_id	includes.users.id, includes.users.name, includes.users.username
user.fields	created_at	includes.users.created_at

Sie sollten nun neben der Schaltfläche „Send“ die folgende URL sehen:

https://api.x.com/2/spaces/search?query=hello&space.fields=creator_id&expansions=creator_id&user.fields=created_at

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

Sobald Sie alles eingerichtet haben, klicken Sie auf die Schaltfläche „Send“ und Sie erhalten die folgende Antwort:

   "data": [
    {
        "creator_id": "2244994945",
        "id": "1zqKVXPQhvZJB",
        "title": "Hallo Welt 👋",
        "state": "Running"
   },
   "includes": {
       "users": [
           {
               "created_at": "2013-12-14T04:35:55.000Z",
               "name": "Twitter Dev",
               "id": "2244994945",
               "username": "TwitterDev"
           }
       ]
   }
]
}