Integrationsleitfaden

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

• Nützliche Tools
• Wichtige Konzepte
• Authentifizierung
• Entwicklerportal, Projects und Apps
• Rate Limits
• Fields und expansions

​

Nützliche Tools

Bevor wir auf einige Kernkonzepte 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 etwas Code in Ihrer bevorzugten Programmiersprache nutzen? Wir stellen mehrere unterschiedliche Codebeispiele bereit, 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 den Einstieg zu erleichtern. Sie finden Bibliotheken, die mit den v2-endpoints arbeiten, 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 OAuth 1.0a User Context verwenden, um Ihre Anfragen an dieses endpoint zu authentifizieren. 

OAuth 1.0a User Context, was 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 Benutzer zugeordnet sein, in dessen Namen Sie die Anfrage stellen. Wenn Sie einen Satz von Access Tokens für einen anderen Benutzer 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 oder ein Tool wie Postman zu nutzen.

​

Entwicklerportal, Projects und Developer-Apps

Um einen Satz 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 in diesem Project 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, gelten für jedes endpoint Rate Limits, die die Anzahl der Anfragen begrenzen, die Sie im Namen Ihrer App oder eines authentifizierten Nutzers stellen können. 

Diese endpoints sind auf Nutzerebene ratebegrenzt. Das bedeutet, dass der authentifizierte Nutzer, in dessen Namen Sie die Anfrage stellen, das endpoint nur eine bestimmte Anzahl von Malen über jede Developer-App aufrufen kann. 

Die folgende Tabelle zeigt die Rate Limits für jedes endpoint.

Endpoint	HTTP-Methode	Rate Limit
/2/users/:id/pinned_lists	POST	50 Anfragen pro 15 Minuten
/2/users/:id/pinned_lists/:list_id	DELETE	50 Anfragen pro 15 Minuten
/2/users/:id/pinned_lists	GET	15 Anfragen pro 15 Minuten

​

Felder und expansions

Der X API v2 GET endpoint ermöglicht es Nutzern, mithilfe der Parameter fields und expansions genau auszuwählen, welche data sie aus der API abrufen möchten. Der Parameter expansions ermöglicht es, im Payload referenzierte Objekte aufzulösen. Beim Nachschlagen angehefteter Lists können Sie beispielsweise die folgenden expansions anfordern:

• owner_id

Der Parameter fields ermöglicht es Ihnen, genau festzulegen, welche fields innerhalb der verschiedenen Datenobjekte Sie erhalten möchten. Dieser endpoint liefert in erster Linie User-Objekte. Standardmäßig gibt das List-Objekt die Felder id und name zurück. Um zusätzliche Felder wie list.created_at oder list.description zu erhalten, müssen Sie diese ausdrücklich über einen fields-Parameter anfordern. 

Wir haben unserem X API v2 data dictionary eine Anleitung zur gemeinsamen Verwendung von fields and expansions hinzugefügt.

Die folgende Tabelle zeigt die verfügbaren Felder und expansions für den Lookup-endpoint:

Endpoint	Felder	Expansions
/2/users/:id/pinned_lists	list.fields user.fields	owner_id