Zum Hauptinhalt springen

Integrationsleitfaden

Diese Seite enthält Informationen zu mehreren Tools und wichtigen Konzepten, die Sie kennen sollten, wenn Sie die List members endpoints in Ihr System integrieren. Wir haben die Seite in mehrere Abschnitte unterteilt:

Nützliche Tools

Bevor wir auf einige zentrale Konzepte eingehen, 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 jeden Pfad- und Body-Parameter, damit Sie schnell verstehen, 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? Wir stellen mehrere Codebeispiele bereit, die Sie als Ausgangspunkt auf unserer GitHub-Seite verwenden können.

Bibliotheken von Drittanbietern

Nutzen Sie eine der Bibliotheken von Drittanbietern aus unserer Community, um den Einstieg zu erleichtern. Sie finden eine Bibliothek, die mit den v2 endpoints funktioniert, indem Sie nach dem passenden Versions-Tag suchen.

Wichtige Konzepte

Authentifizierung

Alle X API v2 endpoints erfordern, dass Sie Ihre Anfragen mit einem Satz von Zugangsdaten authentifizieren, auch bekannt als Keys und Tokens. Sie können entweder OAuth 1.0a User Context, OAuth 2.0 Authorization Code mit PKCE oder App only verwenden, um Ihre Anfragen für die Lists-lookup endpoints zu authentifizieren. Für die manage Lists endpoints müssen Sie jedoch mit OAuth 1.0a User Context oder OAuth 2.0 authentifizieren. OAuth 1.0a User Context bedeutet, dass Sie einen Satz von API Keys und benutzerspezifischen Access Tokens verwenden müssen, um eine erfolgreiche Anfrage zu stellen. Die access tokens müssen dem Benutzer zugeordnet sein, in dessen Namen Sie die Anfrage stellen. Wenn Sie einen Satz von Access Tokens für einen anderen Benutzer erzeugen möchten, muss dieser Ihre App mithilfe des 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 die Verwendung einer Library, eines Tools wie Postman oder die Verwendung von OAuth 2.0 bzw. App only zur Authentifizierung Ihrer Anfragen. OAuth 2.0 Authorization Code mit PKCE ermöglicht eine feinere Kontrolle über den Umfang (Scope) einer Anwendung sowie Autorisierungsabläufe über mehrere Geräte hinweg. OAuth 2.0 erlaubt es Ihnen, spezifische, feingranulare Scopes auszuwählen, die Ihnen bestimmte Berechtigungen im Namen eines Benutzers geben. Um OAuth 2.0 in Ihrer App zu aktivieren, müssen Sie dies in den Authentifizierungseinstellungen Ihrer App aktivieren, die im Abschnitt App-Einstellungen des Entwicklerportals zu finden sind. App only erfordert lediglich, dass Sie Ihrer Anfrage ein App only Access Token beifügen. Sie können ein App only Access Token entweder direkt innerhalb einer Developer-App generieren oder eines über den POST oauth2/token endpoint erzeugen. App only erfordert lediglich, dass Sie Ihrer Anfrage ein App only Access Token beifügen. Sie können ein App only Access Token entweder direkt innerhalb einer Developer-App generieren oder eines über den POST oauth2/token endpoint erzeugen.

Entwicklerportal, Projects und Developer-Apps

Um eine Reihe von Authentifizierungsdaten zu erhalten, die mit den X API v2 endpoints funktionieren, 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 verwalten, 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.  Lookup-(GET)-endpoints unterliegen sowohl auf App- als auch auf Nutzer-Ebene Rate Limits; Manage-(POST/DELETE)-endpoints sind auf Nutzer-Ebene begrenzt. Das App-Rate-Limit bedeutet, dass Sie als Entwickler innerhalb eines bestimmten Zeitraums von einer beliebigen App aus nur eine bestimmte Anzahl von Anfragen an dieses endpoint stellen können (unter Verwendung entweder des API Key und API Secret Key oder des App only Access Token). Das Nutzer-Rate-Limit bedeutet, dass der authentifizierte Nutzer, in dessen Namen Sie die Anfrage stellen, eine List-Abfrage nur eine bestimmte Anzahl von Malen über jede Developer-App hinweg ausführen kann. Die folgende Tabelle zeigt die Rate Limits für jedes endpoint.
EndpointHTTP-MethodeRate Limit
/2/lists/:id/membersGET900 Anfragen pro 15 Minuten
/2/users/:id/list_membershipsGET75 Anfragen pro 15 Minuten
/2/lists/:id/membersPOST300 Anfragen pro 15 Minuten
/2/lists/:id/members/:user_idDELETE300 Anfragen pro 15 Minuten

Felder und Expansions

Das X API v2 GET endpoint ermöglicht es Nutzern, mit Hilfe der Parameter fields und expansions genau die data auszuwählen, die sie von der API zurückgeben lassen möchten. Der Parameter expansions ermöglicht es, Objekte zu erweitern, auf die in der Payload verwiesen wird. Beim Abrufen von List-Mitgliedern können Sie beispielsweise die folgenden expansions anfordern:
  • pinned_tweet_id
Der Parameter fields ermöglicht es Ihnen, genau die fields innerhalb der verschiedenen Datenobjekte auszuwählen, die Sie erhalten möchten. Die Abfrage von List-Mitgliedern liefert primär 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.description zu erhalten, müssen Sie diese explizit über den Parameter user.fields anfordern.  Wir haben eine Anleitung zur Verwendung von fields und expansions hinzugefügt. Die folgende Tabelle zeigt die für jedes Lookup-endpoint verfügbaren Felder und Expansions:
EndpointFelderExpansions
/2/lists/:id/membersuser.fields

tweet.fields
pinned_tweet_id
/2/users/:id/list_membershipslist.fields

user.fields
owner_id
Beim Abrufen von Mitgliedschaften/Mitgliedern können sehr viele data zurückgegeben werden. Um jederzeit konsistente und performante Ergebnisse bereitzustellen, verwenden wir Paginierung. Paginierung ist eine Funktion in X API v2 endpoints, die mehr Ergebnisse liefert, als in einer einzelnen Antwort zurückgegeben werden können. In diesem Fall werden die data in einer Reihe von „Seiten“ zurückgegeben. Erfahren Sie mehr darüber, wie Sie durch Ergebnisse paginieren.
I