Skip to main content

Einführung

Um einen Bot für X (Twitter) auf Square Cloud zu entwickeln und zu hosten, ist es wichtig, einer strukturierten Abfolge von Konfigurationen und Voraussetzungen zu folgen. Dieser technische Leitfaden deckt den gesamten Prozess ab, von der anfänglichen Einrichtung bis zum Produktions-Deployment.

Voraussetzungen

  • Square Cloud Konto: Registriere dich über die Registrierungsseite mit deiner E-Mail-Adresse.
  • Aktiver Plan: Stellt dedizierte Ressourcen und optimierte Leistung für deine Anwendung sicher. Sieh dir unsere verfügbaren Pläne an und wähle den passendsten für deine Bedürfnisse.

Projekt erstellen

Ein aktives X (Twitter)-Konto ist für die Authentifizierung und den Betrieb des Bots erforderlich. Wenn du kein Konto hast, registriere dich auf der offiziellen X-Website.
Ein X-Developer-Konto ist ebenfalls erforderlich, um auf die APIs zuzugreifen. Beantrage den Zugriff über das X Developer Portal.
Die X API wird nach Nutzung abgerechnet: Das Lesen von Erwähnungen und das Posten von Antworten wird deinem X-Developer-Konto berechnet, einschließlich der regelmäßigen Erwähnungsprüfungen des Bots. Prüfe vor dem Deploy die aktuellen Preise auf der Preisseite der X API.

Bot-Anwendung auf X

1

Zugriff auf das Developer Portal

  1. Gehe zum X Developer Portal.
  2. Melde dich mit deinem X (Twitter)-Konto an.
  3. Wenn dies dein erstes Mal ist, schließe den Antragsprozess für den Developer-Zugriff ab.
2

Projekterstellung

  1. Klicke im Dashboard auf “Create Project”.
  2. Wähle einen Namen für dein Projekt (z. B. “Square Cloud Bot”).
  3. Wähle den am besten geeigneten Anwendungsfall (z. B. “Making a bot”).
  4. Gib eine detaillierte Beschreibung deines Bots an.
  5. Bestätige die Projekterstellung.
3

Anwendung einrichten

  1. Klicke innerhalb des erstellten Projekts auf “Create App”.
  2. Lege einen eindeutigen Namen für deine Anwendung fest.
  3. Bestätige die Erstellung der Anwendung.
  4. Notiere dir die generierte App ID für die spätere Verwendung.
4

API-Schlüssel generieren

  1. Navigiere zum Abschnitt “Keys and tokens” deiner Anwendung.
  2. Klicke im Abschnitt “Consumer Keys” auf “Regenerate”, um Folgendes zu generieren:
    • API Key (Consumer Key)
    • API Secret Key (Consumer Secret)
  3. Wichtig: Kopiere und speichere diese Schlüssel sofort, da du sie nicht erneut ansehen kannst.
5

Berechtigungen konfigurieren

  1. Gehe zum Abschnitt “App permissions”.
  2. Klicke auf “Edit”, um die Berechtigungen zu ändern.
  3. Wähle “Read and write”, damit dein Bot Tweets posten kann.
  4. Wähle bei Bedarf “Read and write and Direct message” für DM-Funktionalität.
  5. Speichere die Änderungen.
6

Access Tokens generieren

  1. Kehre zum Abschnitt “Keys and tokens” zurück.
  2. Klicke im Abschnitt “Access Token and Secret” auf “Generate”.
  3. Bestätige die Token-Generierung.
  4. Kopiere und speichere:
    • Access Token
    • Access Token Secret
  5. Warnung: Diese Tokens können nach dem Schließen der Seite nicht erneut angezeigt werden.
7

Anmeldedaten überprüfen

  1. Stelle sicher, dass du alle 4 erforderlichen Anmeldedaten hast:
    • API Key (Consumer Key)
    • API Secret Key (Consumer Secret)
    • Access Token
    • Access Token Secret
  2. Bewahre diese Anmeldedaten an einem sicheren Ort auf
  3. Wichtig: Teile oder veröffentliche diese Anmeldedaten niemals öffentlich

Projekt entwickeln

  1. Node.js-Prüfung: Stelle sicher, dass Node.js auf deinem System installiert ist. Andernfalls lade es von der offiziellen Node.js-Website herunter.
  2. Projektinitialisierung: Erstelle ein neues Node.js-Projekt, indem du Folgendes ausführst:
Terminal
  1. Abhängigkeiten installieren: Installiere die für den Bot erforderlichen Bibliotheken:
Terminal
  1. Zugangsdaten: Der Code liest die vier Zugangsdaten aus Umgebungsvariablen, daher landen sie nie in deinem Code. Um den Bot auf deinem Computer zu testen, lege sie in eine .env-Datei und starte den Bot mit node --env-file=.env index.js:
.env
Square Cloud liest diese Datei nicht, wenn der Bot läuft: Dieselben Variablen legst du auf der Plattform unter Zugangsdaten festlegen fest.
  1. Hauptdatei erstellen: Entwickle die Datei index.js mit der Grundstruktur des Bots:
index.js

Square Cloud konfigurieren

Erstelle im Stammverzeichnis deines Projekts, neben index.js, eine Datei squarecloud.app. Sie teilt Square Cloud mit, wie dein Bot ausgeführt wird:
squarecloud.app
  • MEMORY ist der RAM des Bots in MB. Bots brauchen mindestens 256 MB; mit 512 MB hast du Luft zum Wachsen.
  • AUTORESTART=true startet den Bot nach einem Absturz neu. Lies dazu, wie der automatische Neustart funktioniert.
  • Es gibt keine SUBDOMAIN: Der Bot ruft die X API auf und liefert keine Webseiten aus.
Deine ZIP-Datei enthält index.js, package.json und squarecloud.app. Lass node_modules und deine .env-Datei weg: Füge deiner Datei squarecloud.ignore eine Zeile mit .env hinzu, damit die CLI sie überspringt. Alle Felder findest du in der Referenz zur Konfigurationsdatei.

Zugangsdaten festlegen

Sicherheit: Füge deine API-Zugangsdaten niemals direkt in den Code ein. Verwende auf Square Cloud immer Umgebungsvariablen.
Der Bot braucht vier Umgebungsvariablen:
  • API_KEY: Dein X-API-Schlüssel
  • API_SECRET_KEY: Dein geheimer X-API-Schlüssel
  • ACCESS_TOKEN: Dein Access Token
  • ACCESS_TOKEN_SECRET: Dein Access Token Secret
Lege sie auf eine dieser Arten fest:
  • Dashboard: Öffne auf der Upload-Seite Erweiterte Konfiguration und füge die vier Variablen hinzu. Bei einem bereits deployten Bot fügst du sie auf der Seite Umgebungsvariablen der Anwendung hinzu und startest den Bot neu.
  • CLI: Lade sie direkt nach dem Upload des Bots (siehe Deployen) mit squarecloud app env set aus deiner lokalen .env-Datei und starte den Bot neu:
Der Bot liest seine Umgebungsvariablen beim Start, starte ihn deshalb nach jeder Änderung neu. Weitere Möglichkeiten, sie zu verwalten, findest du unter Umgebungsvariablen.

Deployen

Nachdem du deine Projektdateien vorbereitet hast, kannst du sie nun auf Square Cloud hochladen und dein Projekt hosten. Erstelle dazu eine ZIP-Datei, die alle deine Projektdateien enthält.

Über das Dashboard

1

Upload-Seite aufrufen

Rufe die Upload-Seite auf und lade die ZIP-Datei deines Projekts hoch.
2

Umgebung konfigurieren

Nachdem du deine ZIP-Datei hochgeladen hast, musst du den Namen, die Hauptdatei oder Runtime-Umgebung und weitere Einstellungen für dein Projekt konfigurieren.
Wenn du ein Web-Projekt hochlädst, achte darauf, “Web Publication” auszuwählen und deinem Projekt eine Subdomain zuzuweisen.
3

Projekt bereitstellen

Klicke abschließend auf die Schaltfläche “Deploy”, um dein Projekt auf Square Cloud zu hosten.
Nach dem Deploy kannst du den Status und die Logs deines Projekts über das Dashboard überwachen.
Anwendung wird auf Square Cloud hochgeladen
4

Bestätige, dass deine App live ist

Dein erstes Deploy dauert in der Regel weniger als eine Minute. Warte im Dashboard, bis der Status deiner Anwendung als “running” angezeigt wird, und prüfe die Logs auf Startfehler.
Wenn du eine Website oder API bereitgestellt hast, öffne https://<deine-subdomain>.squareweb.app in deinem Browser: du solltest sehen, dass deine Anwendung reagiert. Wenn du einen Bot bereitgestellt hast, sende ihm einen Befehl, um zu bestätigen, dass er online ist.
App startet nicht? Im Leitfaden zur Fehlerbehebung findest du die häufigsten Ursachen und Lösungen.

Über die CLI

Um diese Methode zu nutzen, braucht dein Projekt eine Konfigurationsdatei mit dem Namen squarecloud.app im Stammverzeichnis. Sie teilt Square Cloud mit, wie deine Anwendung ausgeführt wird.

Leitfaden zur Konfigurationsdatei

Erfahre, wie du die Konfigurationsdatei squarecloud.app erstellst, die die Umgebung deiner Anwendung definiert.
1

CLI installieren

Installiere die Square Cloud CLI. Falls du sie bereits hast, führe denselben Befehl aus, um sie zu aktualisieren:
2

Anmelden

Führe den folgenden Befehl aus. Er öffnet deinen Browser: Bestätige dort die Anmeldung, und die CLI ist einsatzbereit. Es gibt keinen API-Schlüssel zu kopieren. Für Skripte und CI siehe CLI-Authentifizierung.
3

Projekt hochladen

Führe in deinem Projektordner den folgenden Befehl aus. Die CLI packt den aktuellen Ordner als ZIP, lässt dabei weg, was in der squarecloud.ignore steht, und lädt ihn hoch:
Um eine selbst erstellte ZIP-Datei hochzuladen, übergib sie mit --file:
4

Bestätige, dass deine App live ist

Dein erstes Deploy dauert in der Regel weniger als eine Minute. Prüfe den Status und die Logs deiner Anwendung direkt im Terminal:
Wenn du eine Website oder API bereitgestellt hast, öffne https://<deine-subdomain>.squareweb.app in deinem Browser: du solltest sehen, dass deine Anwendung reagiert. Wenn du einen Bot bereitgestellt hast, sende ihm einen Befehl, um zu bestätigen, dass er online ist.
App startet nicht? Im Leitfaden zur Fehlerbehebung findest du die häufigsten Ursachen und Lösungen.

Bot testen

Prüfe nach dem Deployment die Anwendungslogs im Square Cloud Dashboard auf die Meldung Bot successfully initialized!, um zu bestätigen, dass sich der Bot korrekt authentifiziert hat. Poste dann von einem anderen Konto aus einen Tweet, der den Bot mit !ping erwähnt (zum Beispiel @your_bot !ping), und bestätige, dass er innerhalb weniger Minuten auf X mit Pong! 🤖 X Bot working correctly! antwortet. Erwähnungen, die vor dem Start des Bots gepostet wurden, werden übersprungen.

Weiterführende Themen

Die folgenden Snippets erweitern index.js: Füge sie der Datei hinzu und rufe sie dort auf, wo dein Bot sie braucht.

Hashtag-Überwachung

Geplante Posts

Rate Limiting

X (Twitter) hat strikte Rate Limits. Implementiere Kontrollen, um das Überschreiten dieser Limits zu vermeiden:

Fehlerbehandlung

Weitere Ressourcen

Um dein Wissen über die Entwicklung von X-Bots mit twitter-api-v2 zu vertiefen, konsultiere die offizielle Dokumentation der twitter-api-v2-Bibliothek. Die Dokumentation bietet detaillierte Anleitungen, fortgeschrittene Tutorials und vollständige API-Referenzen, um deine Implementierung optimal zu gestalten. Siehe auch:

Nächste Schritte

App startet nicht

Behebe fehlende Module, Speicherfehler und andere Startprobleme.

Umgebungsvariablen

Verwalte die Zugangsdaten deines Bots und andere Secrets.

Node.js-Runtime

So führt Square Cloud Node.js-Anwendungen aus.

Kontaktiere uns

Falls du weiterhin technische Schwierigkeiten hast, steht dir unser spezialisiertes Support-Team zur Verfügung. Kontaktiere uns und wir helfen dir gerne, jedes Problem zu lösen: die Qualität unseres Supports ist ein wichtiger Grund, warum Entwickler Square Cloud mit 4,9/5 bei 402 Bewertungen auf Google und Trustpilot bewerten.