Zum Hauptinhalt springen
Diese Seite enthält Informationen zu mehreren Tools und Schlüsselkonzepten, die Sie kennen sollten, wenn Sie die users Lookup-endpoints in Ihr System integrieren. Wir haben die Seite in mehrere Abschnitte unterteilt:

Nützliche Tools

Bevor wir uns einigen zentralen Konzepten zuwenden, die Ihnen bei der Integration dieses endpoint helfen, empfehlen wir, sich mit Folgendem vertraut zu machen:

Postman

Postman ist ein hervorragendes Tool, mit dem Sie ein Endpoint testen können. Jede Postman-Anfrage enthält alle Pfad- und Body-Parameter, damit Sie schnell nachvollziehen können, was verfügbar ist. Weitere Informationen zu unseren Postman-Collections finden Sie auf unserer Seite “Using Postman”

Codebeispiele

Möchten Sie dieses endpoint mit Code in Ihrer bevorzugten Programmiersprache einrichten? Auf unserer GitHub-Seite finden Sie mehrere Codebeispiele, die Sie als Ausgangspunkt verwenden können.

Bibliotheken von Drittanbietern

Nutzen Sie eine der von unserer Community bereitgestellten Bibliotheken von Drittanbietern, um den Einstieg zu erleichtern. Sie können eine mit den v2-endpoints kompatible Bibliothek finden, indem Sie nach dem passenden Versions-Tag suchen.

Zentrale Konzepte

Authentifizierung

Alle X API v2 endpoints erfordern, dass Anfragen mit einem Satz von Anmeldeinformationen authentifiziert werden, auch bekannt als Keys und Tokens. Sie können entweder OAuth 1.0a User Context, App only oder OAuth 2.0 Authorization Code mit PKCE verwenden, um Anfragen an diese endpoints zu authentifizieren.  OAuth 1.0a User Context erfordert die Nutzung Ihrer API Keys, der user Access Tokens und einiger weiterer Parameter, um einen Authorization-Header zu erstellen, den Sie anschließend mit Ihrer Anfrage übermitteln. Die Access Tokens müssen dem Nutzer zugeordnet sein, in dessen Namen Sie die Anfrage stellen. Wenn Sie einen Satz von Access Tokens für einen anderen Nutzer generieren möchten, muss dieser Ihre App über den 3-legged OAuth-Flow autorisieren.  Bitte beachten Sie, dass OAuth 1.0a schwierig zu verwenden sein kann. Wenn Sie mit dieser Authentifizierungsmethode nicht vertraut sind, empfehlen wir, eine Bibliothek zu verwenden, ein Tool wie Postman zu nutzen oder OAuth 2.0 zu verwenden, um Ihre Anfragen zu authentifizieren. Wenn Sie einen Post oder private metrics von diesen endpoints anfordern möchten, müssen Sie entweder OAuth 1.0a User Context oder OAuth 2.0 Authorization Code mit PKCE verwenden, was sicherstellt, dass Sie die entsprechenden Berechtigungen vom Nutzer besitzen, dem dieser Inhalt gehört.   App only erfordert lediglich, dass Sie einen App only Access Token mit Ihrer Anfrage übermitteln. Sie können einen App only Access Token entweder direkt innerhalb einer Developer-App generieren oder einen mithilfe des POST oauth2/token endpoint erzeugen. OAuth 2.0 Authorization Code mit PKCE ermöglicht eine feinere Kontrolle über den Scope einer Anwendung sowie Autorisierungsabläufe über mehrere Geräte hinweg. OAuth 2.0 erlaubt Ihnen, spezifische, fein granulierte Scopes auszuwählen, die Ihnen bestimmte Berechtigungen im Namen eines Nutzers geben.  Um OAuth 2.0 in Ihrer App zu aktivieren, müssen Sie es in den Authentifizierungseinstellungen Ihrer App aktivieren, die im Abschnitt App-Einstellungen des Entwicklerportals zu finden sind. Bitte beachten Wenn Sie die folgenden fields anfordern, ist OAuth 1.0a User Context oder OAuth 2.0 Authorization Code erforderlich: 
  • tweet.fields.non_public_metrics
  • tweet.fields.promoted_metrics
  • tweet.fields.organic_metrics

Entwicklerportal, Projects und Developer-Apps

Um einen Satz von Authentifizierungsdaten zu erhalten, der mit den X API v2 endpoints funktioniert, müssen Sie sich für ein Developer-Konto registrieren, ein Project innerhalb dieses Kontos einrichten und eine Developer-App innerhalb dieses Projects erstellen. Anschließend finden Sie Ihre Keys und Tokens in Ihrer Developer-App.   

Rate Limits

Jeden Tag senden viele Tausend Entwickler Anfragen an die X API. Um das enorme Volumen dieser Anfragen zu steuern, werden für jedes endpoint Rate Limits festgelegt, die die Anzahl der Anfragen begrenzen, die Sie im Namen Ihrer App oder eines authentifizierten Nutzers stellen können.  Die user lookup endpoints unterliegen Rate Limits sowohl auf App- als auch auf Nutzer-Ebene. Allerdings unterliegt das authenticated user lookup endpoint einem Rate Limit auf Nutzer-Ebene. Das App-Level-Rate-Limit bedeutet, dass Sie als Entwickler innerhalb eines bestimmten Zeitraums nur eine bestimmte Anzahl von Anfragen an dieses endpoint aus einer beliebigen App stellen können (ermittelt über die Keys und Tokens, die Sie verwenden). Das User-Level-Rate-Limit bedeutet, dass der authentifizierte Nutzer, in dessen Namen Sie die Anfrage stellen, dies nur eine bestimmte Anzahl von Malen über jede Developer-App hinweg durchführen kann. Die folgende Tabelle zeigt die Rate Limits für jedes endpoint.
EndpointHTTP-MethodeRate Limit / Level
/2/usersGET900 requests per 15 minutes / App and User
/2/users/:idGET900 requests per 15 minutes / App and User
/2/users/byGET900 requests per 15 minutes / App and User
/2/users/by/username/:usernameGET900 requests per 15 minutes / App and User
/2/users/meGET75 requests per 15 minutes / User

Fields und expansions

Die X API v2 ermöglicht es Nutzern, mithilfe eines Satzes von Tools namens fields und expansions genau auszuwählen, welche data sie aus der API zurückerhalten möchten. Der expansions-Parameter ermöglicht es, Objekte zu erweitern, die in der Payload referenziert werden. Zum Beispiel erlaubt dieser endpoint die Verwendung der pinned_tweet_id-Expansion. Der fields-Parameter ermöglicht Ihnen, genau auszuwählen, welche fields innerhalb der verschiedenen Datenobjekte Sie erhalten möchten. Diese endpoints liefern in erster Linie User-Objekte. Standardmäßig gibt das User-Objekt die Felder id, name und username zurück. Um zusätzliche Felder wie user.created_at oder user.location zu erhalten, müssen Sie diese ausdrücklich mit einem fields-Parameter anfordern. Einige wichtige Felder, die Sie in Ihrer Integration in Betracht ziehen sollten, sind unsere Post-Umfrage-Daten, metrics, Annotations und conversation ID-Felder. Wir haben eine Anleitung hinzugefügt, wie Sie fields und expansions verwenden in unserem X API v2 Data Dictionary.

Sonderfälle

  • Der Post-Text wird bei Retweets gekürzt. Eine kurzfristige Lösung besteht darin, den referenzierten Post zu expandieren und den vollständigen Text aus der Expansion abzurufen. Dies ist ein Fehler, den wir künftig beheben werden.
I