Zum Hauptinhalt springen

​
Erste Schritte mit dem List-Lookup-endpoint

Dieser Schnellstartleitfaden hilft Ihnen, Ihre erste Anfrage an den List-Lookup-endpoint mit Postman zu stellen. Bitte besuchen Sie unser GitHub-Repository X API v2 Sample Code, wenn Sie Beispielcode in verschiedenen Sprachen sehen möchten. Hinweis: In diesem Beispiel senden wir eine Anfrage an den List Lookup by ID-endpoint, aber Sie können die Erkenntnisse aus diesem Schnellstart auch auf andere Lookup-Anfragen anwenden.

​
Voraussetzungen

Um diesen Leitfaden abzuschließen, benötigen Sie eine Reihe 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 zur Seite „Keys und Tokens“ Ihrer App, um die erforderlichen Zugangsdaten zu generieren. Stellen Sie sicher, dass Sie alle Zugangsdaten an einem sicheren Ort speichern.

​
Schritte zum Erstellen einer List-Lookup-Anfrage

Schritt eins: Beginnen Sie mit einem Tool oder einer Bibliothek Es gibt verschiedene Tools, Codebeispiele und Bibliotheken, mit denen Sie eine Anfrage an dieses endpoint stellen können. Wir verwenden hier Postman, um den Prozess zu vereinfachen. Um die X API v2 Postman-Sammlung in Ihre Umgebung zu laden, klicken Sie bitte auf die folgende Schaltfläche:
Sobald Sie die X API v2-Sammlung in Postman geladen haben, navigieren Sie zum Ordner „List“, wählen Sie den Unterordner „List lookup“ und anschließend „List by ID“.   Schritt zwei: Authentifizieren Sie Ihre Anfrage Um eine Anfrage korrekt an die X API zu stellen, müssen Sie sicherstellen, dass Sie berechtigt sind. Für dieses endpoint müssen Sie Ihre Anfrage mithilfe einer der folgenden Authentifizierungsmethoden authentifizieren: App only, OAuth 2.0 Authorization Code with PKCE oder OAuth 1.0a User Context. Der Einfachheit halber verwenden wir für diese Anfrage App only. Wenn Sie jedoch private metrics oder Lists anfordern möchten, müssen Sie eine der anderen Authentifizierungsmethoden verwenden.  Um App only zu verwenden, müssen Sie Ihre Keys und Tokens (insbesondere den App only Access Token) in Postman hinzufügen. Wählen Sie dazu die Umgebung „X API v2“ (oben rechts in Postman) und tragen Sie Ihre Keys und Tokens in die Felder „initial value“ und „current value“ ein (über das Augensymbol neben dem Umgebungs-Dropdown). Wenn Sie dies korrekt gemacht haben, werden diese Variablen automatisch in den Autorisierungs-Tab der Anfrage übernommen.   Schritt drei: Identifizieren und geben Sie an, welche List Sie abrufen möchten Sie müssen die List angeben, die Sie abrufen möchten. Die List ID finden Sie, indem Sie zu x.com navigieren, eine List öffnen und dann in der URL nachsehen. In der folgenden URL ist die List ID beispielsweise 84839422. https://x.com/i/lists/84839422 Die Ziel-ID kann jede gültige List ID sein. Navigieren Sie in Postman zum Tab „Params“ und geben Sie Ihre ID in die Spalte „Value“ der id-Pfadvariable ein. Achten Sie darauf, keine Leerzeichen vor oder nach einer ID einzufügen.
KeyValue
id84839422 (Die List ID)
Schritt vier: Identifizieren und geben Sie an, welche fields Sie abrufen möchten Wenn Sie nach Schritt drei auf die Schaltfläche „Send“ klicken, erhalten Sie die standardmäßigen List object fields in Ihrer Antwort: id, name. Wenn Sie zusätzliche fields erhalten möchten, müssen Sie diese in Ihrer Anfrage über die Parameter list.fields und/oder expansions angeben. Für diese Übung fordern wir drei zusätzliche Sets von fields aus verschiedenen Objekten an:
  • Das zusätzliche created_at-Feld im primären Lists-Objekt.
  • Das vollständige user object mithilfe des expansions-Parameters
  • Das zusätzliche user.created_at-Feld 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
list.fieldscreated_atcreated_at
expansionsowner_idincludes.users.id,
includes.users.name,
includes.users.username
user.fieldscreated_atincludes.users.created_at
Neben der Schaltfläche „Send“ sollten Sie nun eine ähnliche URL sehen: https://api.x.com/2/lists/84839422?list.fields=owner_id&expansions=owner_id&user.fields=created_at Schritt fünf: Senden Sie Ihre Anfrage und prüfen Sie Ihre Antwort Sobald alles eingerichtet ist, klicken Sie auf „Send“, und Sie erhalten eine ähnliche Antwort wie die folgende Beispielantwort: 
{
  "data": {
    "id": "84839422",
    "name": "Offizielle Twitter-Konten",
    "owner_id": "783214"
  },
  "includes": {
    "users": [
      {
        "name": "Twitter",
        "created_at": "2007-02-20T14:35:54.000Z",
        "username": "Twitter",
        "id": "783214"
      }
    ]
  }
}
⌘I