Zum Hauptinhalt springen

​
Erste Schritte mit den Spaces-Lookup-endpoints

Dieser Schnellstartleitfaden hilft Ihnen, Ihre erste Anfrage an einen der Spaces-Lookup-endpoints mit einem Satz angegebener fields mithilfe von Postman zu stellen. Wenn Sie Beispielcode in verschiedenen Programmiersprachen sehen möchten, besuchen Sie bitte unser X API v2 sample code GitHub-Repository.

​
Voraussetzungen

Um diesen Leitfaden abzuschließen, benötigen Sie einen Satz von Keys und Tokens, um Ihre Anfrage zu authentifizieren. Sie können diese Keys und Tokens generieren, indem Sie die folgenden Schritte befolgen:
  • 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 zur Seite „Keys und Tokens“ Ihrer App, um die erforderlichen Anmeldedaten zu generieren. Stellen Sie sicher, dass Sie alle Anmeldedaten an einem sicheren Ort aufbewahren.

​
Schritte zum Erstellen einer Spaces-Lookup-Anfrage

Für dieses Beispiel senden wir eine Anfrage an den Endpoint zur Benutzer‑Spaces‑Abfrage nach Creator‑ID; die Erkenntnisse aus diesem Schnellstart lassen sich jedoch auch auf andere Lookup‑Anfragen anwenden. 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. Wir verwenden hier Postman, um den Prozess zu vereinfachen. Um die X API v2 Postman‑Collection in Ihre Umgebung zu laden, klicken Sie bitte auf die folgende Schaltfläche:
Sobald Sie die X API v2‑Collection in Postman geladen haben, navigieren Sie zum Ordner Spaces und finden Sie die Anfrage „Lookup Spaces created by one or more users“.   Schritt zwei: Authentifizieren Sie Ihre Anfrage Um eine Anfrage an die X API korrekt zu stellen, müssen Sie sicherstellen, dass Sie über die erforderlichen Berechtigungen verfügen. Dieser Endpoint verlangt dafür die Authentifizierung Ihrer Anfrage mit entweder OAuth 2.0 App-Only oder OAuth 2.0 Authorization Code mit PKCE. Der Einfachheit halber verwenden wir für diese Anfrage OAuth 2.0 App-Only. Möchten Sie jedoch private metrics oder Spaces eines privaten Nutzers anfordern, müssen Sie eine der anderen Authentifizierungsmethoden verwenden.  Um OAuth 2.0 App-Only zu nutzen, müssen Sie Ihre Keys und Tokens hinzufügen, insbesondere das App Access Token (auch als App-only Bearer Token bekannt), und in Postman hinterlegen. Wählen Sie dazu oben rechts in Postman die Umgebung „X API v2“ und tragen Sie Ihre Keys und Tokens in die Felder „initial value“ und „current value“ ein (über das Augensymbol neben dem Umgebungs‑Dropdown). Diese Variablen werden automatisch im Authorization‑Tab der Anfrage verwendet, wenn Sie alles korrekt konfiguriert haben.   Schritt drei: Legen Sie fest, von welchem Nutzer Sie Posts abrufen möchten Sie müssen in der Anfrage angeben, für welchen Nutzer Sie laufende oder bevorstehende Spaces abrufen möchten. In diesem Beispiel übergeben wir eine einzelne Nutzer‑ID. Nutzer‑IDs sind der numerische Wert, der ein Account‑Handle repräsentiert und den Sie in der Profil‑URL eines Accounts finden können. Der Benutzername des folgenden Accounts lautet beispielsweise XDevelopers. https://x.com/XDevelopers Um diesen Benutzernamen in die Nutzer‑ID umzuwandeln, verwenden Sie den User‑Lookup‑Endpoint mit dem Benutzernamen und entnehmen die numerische Nutzer‑ID dem Payload. Im Fall von @XDevelopers ist die Nutzer‑ID 2244994945. Navigieren Sie in Postman zum Tab „Params“ und geben Sie diese Nutzer‑ID in die Spalte „Value“ des Parameters id ein.
KeyValue
id2244994945
Schritt vier: Legen Sie fest, welche fields Sie abrufen möchten Wenn Sie nach Schritt drei auf die Schaltfläche „Send“ klicken, erhalten Sie eine id. Das ist das einzige Space object field, das standardmäßig in Ihrer Antwort zurückgegeben wird. Wenn Sie zusätzliche fields erhalten möchten, müssen Sie diese in Ihrer Anfrage über die Parameter space.fields oder expansions angeben. Für diese Übung fordern wir drei zusätzliche Field‑Sets aus verschiedenen Objekten an:
  • Das zusätzliche title field im primären Spaces‑Objekt.
  • Das vollständige User-Objekt der angegebenen creator_id
  • Das zusätzliche user.created_at field im zugehörigen User‑Objekt.
Navigieren Sie in Postman zum Tab „Params“ und fügen Sie das folgende Key:Value‑Paar zur Tabelle „Query Params“ hinzu:
KeyValueReturned fields
space.fieldstitlecreator_id
expansionscreator_idincludes.users.id, includes.users.name, includes.users.username
user.fieldscreated_atincludes.users.created_at
Sie sollten nun die folgende URL neben der Schaltfläche „Send“ sehen: https://api.x.com/2/spaces/by/creator_ids?user_ids=2244994945&space.fields=creator_id&expansions=creator_id&user.fields=created_at Schritt fünf: Senden Sie Ihre Anfrage und prüfen Sie die Antwort Sobald alles eingerichtet ist, 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"
           }
       ]
   }
]
}
⌘I