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

Nützliche Tools

Bevor wir auf einige Schlüsselkonzepte 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 alle Pfad- und Body-Parameter, damit Sie schnell verstehen, welche Optionen Ihnen zur Verfügung stehen. Weitere Informationen zu unseren Postman-Sammlungen finden Sie auf unserer Seite “Using Postman”

Codebeispiele

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

Bibliotheken von Drittanbietern

Nutzen Sie eine der Bibliotheken von Drittanbietern aus unseren Communities, um schneller loszulegen. Sie können eine Bibliothek finden, die mit den v2 endpoints arbeitet, 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 Anmeldedaten authentifizieren, 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 Ihre Anfragen an diese endpoints zu authentifizieren. OAuth 1.0a User Context bedeutet, dass Sie einen Satz von API Keys und Benutzer-Access Tokens verwenden müssen, um eine erfolgreiche Anfrage zu stellen. 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 library zu verwenden, ein Tool wie Postman zu nutzen oder OAuth 2.0 zu verwenden, um Ihre Anfragen zu authentifizieren. 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. Mit OAuth 2.0 können Sie spezifische, fein granulierte Scopes auswählen, die Ihnen bestimmte Berechtigungen im Namen eines Nutzers gewähren. Um OAuth 2.0 in Ihrer App zu aktivieren, müssen Sie es in den Authentifizierungseinstellungen Ihrer App aktivieren, die Sie im Bereich App settings des Entwicklerportals finden. App only erfordert lediglich, dass Sie Ihrer Anfrage ein App only Access Token beifügen. Sie können entweder ein App only Token direkt innerhalb einer Developer-App erzeugen oder eines über das endpoint POST oauth2/token generieren.

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 anmelden, 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 auf jeden Endpoint Rate Limits angewendet, die die Anzahl der Anfragen begrenzen, die Sie im Namen Ihrer App oder eines authentifizierten Nutzers stellen können. Diese Endpoints sind sowohl auf App‑Ebene als auch auf Nutzer‑Ebene ratebegrenzt. 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 diesen 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 beliebige Developer‑Apps durchführen kann. Die folgende Tabelle zeigt die Rate Limits für jeden Endpoint.
EndpointHTTP-MethodeRate Limit
/2/lists/:idGET75 requests per 15 minutes
/2/users/:id/owned_listsGET15 requests per 15 minutes
Fields und Expansions Der X API v2 GET Endpoint ermöglicht es Nutzern, mit einem Satz von Tools namens fields und expansions genau auszuwählen, welche data sie von der API zurückerhalten möchten. Der Parameter expansions ermöglicht es, im Payload referenzierte Objekte zu erweitern. Wenn Sie beispielsweise eine List per ID nachschlagen, können Sie die folgenden expansions abrufen:
  • owner_id
Der Parameter fields ermöglicht es Ihnen, genau auszuwählen, welche fields innerhalb der verschiedenen data‑Objekte Sie erhalten möchten. Diese Endpoints liefern primär List‑Objekte. Standardmäßig gibt das List‑Objekt die id- und name-Fields zurück. Um zusätzliche Fields wie list.created_at oder list.follower_count zu erhalten, müssen Sie diese ausdrücklich über einen list.fields‑Parameter anfordern. Wir haben unserer X API v2 data dictionary eine Anleitung zur gemeinsamen Verwendung von fields und expansions hinzugefügt. Die folgende Tabelle zeigt die für diese Endpoint‑Gruppe verfügbaren Fields und Expansions:
EndpointFieldsExpansions
/2/lists/:idlist.fields

user.fields
owner_id
/2/users/:id/owned_listslist.fields

user.fields
owner_id
Das Abrufen von vom Benutzer erstellten Lists kann eine große Menge an data zurückgeben. Um jederzeit konsistente und performante Ergebnisse zu liefern, verwenden wir Paginierung. Paginierung ist eine Funktion in X API v2 endpoints, die mehr Ergebnisse zurückgeben, als in einer einzelnen Antwort enthalten sein 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