Übersicht
- API Key und Secret: Im Wesentlichen der Benutzername und das Passwort für Ihre App. Sie verwenden diese, um Anfragen zu authentifizieren, die OAuth 1.0a User Context erfordern, oder um andere Tokens wie Benutzer-Access Tokens oder App Access Token zu generieren.
- Access Token und Secret: Allgemein repräsentieren Access Tokens den Benutzer, in dessen Auftrag Sie die Anfrage stellen. Diejenigen, die Sie über das Entwicklerportal generieren können, repräsentieren den Benutzer, dem die App gehört. Sie verwenden diese, um Anfragen zu authentifizieren, die OAuth 1.0a User Context erfordern. Wenn Sie Anfragen im Namen eines anderen Benutzers stellen möchten, müssen Sie den 3-legged OAuth-Flow verwenden, damit dieser Sie autorisiert.
- Client ID und Client Secret: Diese Anmeldedaten werden verwendet, um mittels OAuth 2.0-Authentifizierung ein Benutzer-Access Token zu erhalten. Ähnlich wie bei OAuth 1.0a werden die Benutzer-Access Tokens verwendet, um Anfragen zu authentifizieren, die private Benutzerkontoinformationen bereitstellen oder Aktionen im Namen eines anderen Kontos ausführen, jedoch mit fein abgestuftem Scope für eine bessere Kontrolle darüber, welchen Zugriff die Client-Anwendung auf den Benutzer hat.
- App only Access Token: Sie verwenden dieses Token, wenn Sie Anfragen an endpoints stellen, die mit öffentlich auf X verfügbaren Informationen antworten.
Apps und Projects
Dashboard des Entwicklerportals
- Anzeigen Ihrer vorhandenen Standalone-Apps und der zugehörigen App-id.
- Erstellen eines neuen Projects, einer App oder einer Standalone-App.
- DELETE eines ungenutzten Projects oder einer App.
- Überprüfen oder Aktualisieren der Einstellungen einer bestimmten App, einschließlich Aktualisierung von Name, Beschreibung, Website, Callback-URL und permissions.
- Neuerstellen appspezifischer Anmeldedaten wie API Key & Secret, App Access Token und der user Access Tokens des App-Inhabers.
Anmeldung für den Zugriff
Kennzeichnung „Automated Account“ für Bots
- Gehen Sie zu Ihren Kontoeinstellungen
- Wählen Sie „Your account“
- Wählen Sie „Automation“
- Wählen Sie „Managing account“
- Wählen Sie anschließend das X Konto aus, das Ihr Bot-Konto betreibt
- Geben Sie Ihr Passwort ein, um sich anzumelden
- Abschließend sollten Sie eine Bestätigung sehen, dass das Label auf Ihr Konto angewendet wurde.
Verwaltung von Apps
Einführung
- Anzeigen Ihrer vorhandenen Apps und Projects sowie der zugehörigen App-id.
- Erstellen eines neuen Projects oder einer eigenständigen App.
- Löschen eines Projects, einer App oder einer eigenständigen App.
- Öffnen der Einstellungen einer bestimmten App durch Klicken auf die App. In den Einstellungen können Sie die App-Details, Keys und Tokens sowie Berechtigungen einsehen.
- Aktualisieren der Benutzerauthentifizierungseinstellungen Ihrer App zur Verwendung von OAuth 1.0a oder OAuth 2.0.
Hinweis:Alle App-Keys und Tokens sind im Entwicklerportal nicht mehr einsehbar und müssen nach der Generierung sicher gespeichert werden. Wir empfehlen die Verwendung eines Passwortmanagers zur Aufbewahrung Ihrer Keys und Tokens.Sie können einen API Key‑Hinweis einblenden, um Ihre Zugangsdaten der entsprechenden App zuzuordnen.
App-Einstellungen
App-Details
Keys und Tokens
- API Key (Consumer Key) und API Secret (Consumer Secret)
- App Access Token
- User Access Token und Access Token Secret - Das im Entwicklerportal verfügbare Access Token und Secret beziehen sich auf den Nutzer, dem die App gehört.
Einstellungen zur Benutzer-Authentifizierung
OAuth 1.0a-Berechtigungen für App und Nutzer
OAuth 2.0-Typ der App
App-Berechtigungen
OAuth 1.0a App-Berechtigungen
- Nur Lesen
- Lesen und Schreiben
- Lesen, Schreiben und Zugriff auf Direct Messages
Nur Lesezugriff
Lesen und Schreiben
Lesen, Schreiben und Zugriff auf Direct Messages
- POST /2/dm_conversations/:dm_conversation_id/messages
- POST /2/dm_conversations/
- POST /2/dm_conversations/with/:participant_id/messages
- GET /2/dm_conversations/with/:user_id/dm_events
- GET /2/dm_conversations/:dm_conversation_id/dm_events
- GET /2/dm_events
Berechtigungen ermitteln
x-access-level
-Header. Der Wert dieses Headers gibt die aktuell verwendete Berechtigungsstufe an. Mögliche Werte sind read, read-write und read-write-directmessages.
Callback-URLs
- OAuth 2.0 Authorization Code mit PKCE
- OAuth 1.0a 3-legged OAuth-Flow (und separat der Sign in with X-Flow)
callback_url
übergeben, wenn sie eine Anfrage an den endpoint GET oauth/request_token stellen. Ebenso müssen Entwickler, die OAuth 2.0 Authorization Code mit PKCE verwenden, den Parameter redirect_uri
mit ihrer Anfrage an den endpoint GET oauth2/authorize übergeben.
Zusätzlich zur Verwendung dieser Parameter muss der Entwickler sicherstellen, dass die Callback-URL auch der Allowlist der App für Callback-URLs hinzugefügt wurde, die auf der Einstellungsseite der App im Entwicklerportal zu finden ist.
Wenn alles korrekt eingerichtet ist, werden Nutzer nach erfolgreicher Anmeldung bei X im Rahmen dieser Flows zur Callback-URL weitergeleitet.
Wichtige Hinweise
callback_url
oder redirect_uri
übergeben, stellen Sie bitte sicher, dass die URL HTTP-codiert ist.
Grenzen für Callback-URLs
Im X Apps-Dashboard gibt es eine feste Obergrenze von 10 Callback-URLs. Ihre Callback-URL muss exakt mit der auf die Allowlist gesetzten Callback-URL übereinstimmen, die Sie dem Apps-Dashboard hinzufügen, sowie mit dem Parameter, den Sie im Autorisierungsfluss übergeben.
Wenn Sie anfragebezogene Daten in der Callback-URL übermitteln möchten, können Sie den Parameter state
verwenden, um Daten zu speichern, die nach der Weiterleitung des Nutzers verfügbar sind. Sie können die Daten entweder direkt im Parameter state
kodieren oder den Parameter als Sitzungs-ID nutzen, um den Zustand auf dem Server zu speichern.
Verwenden Sie localhost nicht als Callback-URL
Verwenden Sie lokal statt localhost einen benutzerdefinierten Host oder http(s)://127.0.0.1
Benutzerdefinierte Protokoll-URLs
Wenn Sie Mobile Deep Linking nutzen möchten, können Sie benutzerdefinierte Protokoll-URLs mit Pfad- und Domain-Teil verwenden, z. B. twitter://callback/path. Es gibt jedoch eine Liste nicht zulässiger Protokolle, die Sie vermeiden müssen. Die Liste der nicht zulässigen Protokolle finden Sie unten.
Nicht zulässige Protokolle
vbscript | ldap |
javascript | mailto |
vbs | mmst |
data | mmsu |
mocha | msbd |
keyword | rtsp |
livescript | mso-offdap |
ftp | snews |
file | news |
gopher | nntp |
acrobat | outlook |
callto | stssync |
daap | rlogin |
itpc | telnet |
itms | tn3270 |
firefoxurl | shell |
hcp | sip |
Fehlerbeispiel
HTTP 403 - Forbidden
HTTP 400