Skip to main content

Introduction

Pour développer et héberger un bot X (Twitter) sur Square Cloud, il est essentiel de suivre une séquence structurée de configurations et de prérequis. Ce guide technique couvrira l’ensemble du processus, de la configuration initiale au déploiement en production.

Prérequis

  • Compte Square Cloud : Inscrivez-vous via la page d’inscription en utilisant votre adresse e-mail.
  • Plan actif : Garantit des ressources dédiées et des performances optimisées pour votre application. Consultez nos plans disponibles et choisissez celui qui convient le mieux à vos besoins.

Création du projet

Un compte X (Twitter) actif est requis pour l’authentification et le fonctionnement du bot. Si vous n’avez pas de compte, inscrivez-vous sur le site officiel de X.
Un compte X Developer est également requis pour accéder aux API. Demandez l’accès via le X Developer Portal.
L’API X est payante à l’usage : la lecture des mentions et la publication de réponses sont facturées à votre compte développeur X, y compris les vérifications périodiques des mentions par le bot. Consultez les tarifs actuels sur la page de tarification de l’API X avant de déployer.

Application du bot sur X

1

Accéder au Developer Portal

  1. Rendez-vous sur le X Developer Portal.
  2. Connectez-vous avec votre compte X (Twitter).
  3. Si c’est votre première fois, complétez le processus de demande d’accès développeur.
2

Création du projet

  1. Dans le tableau de bord, cliquez sur “Create Project”.
  2. Choisissez un nom pour votre projet (par ex. “Square Cloud Bot”).
  3. Sélectionnez le cas d’usage le plus approprié (par ex. “Making a bot”).
  4. Fournissez une description détaillée de votre bot.
  5. Confirmez la création du projet.
3

Configuration de l'application

  1. Au sein du projet créé, cliquez sur “Create App”.
  2. Définissez un nom unique pour votre application.
  3. Confirmez la création de l’application.
  4. Notez l’App ID généré pour référence future.
4

Génération des clés d'API

  1. Accédez à la section “Keys and tokens” de votre application.
  2. Dans la section “Consumer Keys”, cliquez sur “Regenerate” pour générer :
    • API Key (Consumer Key)
    • API Secret Key (Consumer Secret)
  3. Important : Copiez et enregistrez ces clés immédiatement, car vous ne pourrez plus les consulter par la suite.
5

Configuration des permissions

  1. Rendez-vous dans la section “App permissions”.
  2. Cliquez sur “Edit” pour modifier les permissions.
  3. Sélectionnez “Read and write” pour permettre à votre bot de publier des tweets.
  4. Si nécessaire, sélectionnez “Read and write and Direct message” pour la fonctionnalité de DM.
  5. Enregistrez les modifications.
6

Génération des jetons d'accès

  1. Retournez dans la section “Keys and tokens”.
  2. Dans la section “Access Token and Secret”, cliquez sur “Generate”.
  3. Confirmez la génération des jetons.
  4. Copiez et enregistrez :
    • Access Token
    • Access Token Secret
  5. Attention : Ces jetons ne peuvent plus être consultés après avoir fermé la page.
7

Vérification des identifiants

  1. Confirmez que vous disposez des 4 identifiants requis :
    • API Key (Consumer Key)
    • API Secret Key (Consumer Secret)
    • Access Token
    • Access Token Secret
  2. Conservez ces identifiants dans un endroit sécurisé
  3. Important : Ne partagez ni n’exposez jamais publiquement ces identifiants

Développement du projet

  1. Vérification de Node.js : Vérifiez que Node.js est installé sur votre système. Sinon, téléchargez-le depuis le site officiel de Node.js.
  2. Initialisation du projet : Créez un nouveau projet Node.js en exécutant :
Terminal
  1. Installation des dépendances : Installez les bibliothèques requises pour le bot :
Terminal
  1. Identifiants : le code lit les quatre identifiants depuis des variables d’environnement : ils n’entrent donc jamais dans votre code. Pour tester le bot sur votre ordinateur, placez-les dans un fichier .env et démarrez le bot avec node --env-file=.env index.js :
.env
Square Cloud ne lit pas ce fichier lorsque le bot s’exécute : vous définissez les mêmes variables sur la plateforme dans Définir les identifiants.
  1. Création du fichier principal : Développez le fichier index.js avec la structure de base du bot :
index.js

Configurer Square Cloud

Créez un fichier squarecloud.app à la racine de votre projet, à côté de index.js. Il indique à Square Cloud comment exécuter votre bot :
squarecloud.app
  • MEMORY est la RAM du bot en Mo. Les bots ont besoin d’au moins 256 Mo ; 512 Mo laissent de la marge pour évoluer.
  • AUTORESTART=true redémarre le bot s’il plante. Consultez le fonctionnement du redémarrage automatique.
  • Il n’y a pas de SUBDOMAIN : le bot appelle l’API X et ne sert pas de pages web.
Votre ZIP contient index.js, package.json et squarecloud.app. Excluez node_modules et votre fichier .env : ajoutez une ligne .env à votre fichier squarecloud.ignore pour que la CLI l’ignore. Consultez la référence du fichier de configuration pour tous les champs.

Définir les identifiants

Sécurité : N’incluez jamais vos identifiants d’API directement dans le code. Utilisez toujours des variables d’environnement sur Square Cloud.
Le bot a besoin de quatre variables d’environnement :
  • API_KEY : Votre clé d’API X
  • API_SECRET_KEY : Votre clé secrète d’API X
  • ACCESS_TOKEN : Votre jeton d’accès
  • ACCESS_TOKEN_SECRET : Votre secret de jeton d’accès
Définissez-les de l’une de ces façons :
  • Tableau de bord : sur la page d’envoi, ouvrez Configuration avancée et ajoutez les quatre variables. Pour un bot déjà déployé, ajoutez-les sur la page Variables d’environnement de l’application et redémarrez le bot.
  • CLI : juste après avoir envoyé le bot (voir Déploiement), chargez-les depuis votre fichier .env local avec squarecloud app env set et redémarrez le bot :
Le bot lit ses variables d’environnement au démarrage : redémarrez-le donc après chaque modification. Consultez Variables d’environnement pour les autres façons de les gérer.

Déploiement

Après avoir préparé les fichiers de votre projet, vous pouvez maintenant les téléverser sur Square Cloud et héberger votre projet. Pour ce faire, créez un fichier ZIP contenant tous les fichiers de votre projet.

Via le tableau de bord

1

Accéder à la page d'upload

Accédez à la page d’upload et téléversez le fichier zip de votre projet.
2

Configurer votre environnement

Après avoir téléversé votre zip, vous devrez configurer le nom, le fichier principal ou l’environnement d’exécution ainsi que d’autres paramètres de votre projet.
Si vous téléversez un projet web, veillez à sélectionner « Publication Web » et à définir un sous-domaine pour votre projet.
3

Déployer votre projet

Enfin, cliquez sur le bouton « Deploy » pour héberger votre projet sur Square Cloud.
Une fois le déploiement effectué, vous pouvez suivre l’état et les logs de votre projet depuis le tableau de bord.
Téléversement d'une application vers Square Cloud
4

Confirmez que votre application est en ligne

Votre premier déploiement prend généralement moins d’une minute. Dans le tableau de bord, attendez que le statut de votre application affiche « en cours d’exécution » et vérifiez les logs pour détecter d’éventuelles erreurs de démarrage.
Si vous avez déployé un site web ou une API, ouvrez https://<votre-sous-domaine>.squareweb.app dans votre navigateur, vous devriez voir votre application répondre. Si vous avez déployé un bot, envoyez-lui une commande pour confirmer qu’il est en ligne.
Votre application ne démarre pas ? Consultez le guide de dépannage pour les causes les plus courantes et leurs solutions.

Via la CLI

Pour utiliser cette méthode, votre projet a besoin d’un fichier de configuration nommé squarecloud.app à sa racine. Il indique à Square Cloud comment exécuter votre application.

Guide du fichier de configuration

Apprenez comment créer le fichier de configuration squarecloud.app qui définit l’environnement de votre application.
1

Installer la CLI

Installez la CLI Square Cloud. Si vous l’avez déjà, exécutez la même commande pour la mettre à jour :
2

Se connecter

Exécutez la commande ci-dessous. Elle ouvre votre navigateur : approuvez-y la connexion et la CLI est prête. Il n’y a aucune clé API à copier. Pour les scripts et la CI, consultez Authentification de la CLI.
3

Téléverser votre projet

Depuis le dossier de votre projet, exécutez la commande ci-dessous. La CLI compresse le dossier courant en zip, sans ce que liste squarecloud.ignore, puis l’envoie :
Pour téléverser un zip que vous avez créé vous-même, passez-le avec --file :
4

Confirmez que votre application est en ligne

Votre premier déploiement prend généralement moins d’une minute. Vérifiez le statut et les logs de votre application directement depuis le terminal :
Si vous avez déployé un site web ou une API, ouvrez https://<votre-sous-domaine>.squareweb.app dans votre navigateur, vous devriez voir votre application répondre. Si vous avez déployé un bot, envoyez-lui une commande pour confirmer qu’il est en ligne.
Votre application ne démarre pas ? Consultez le guide de dépannage pour les causes les plus courantes et leurs solutions.

Tester le bot

Après le déploiement, vérifiez les logs de l’application dans le tableau de bord Square Cloud pour repérer le message Bot successfully initialized! confirmant que le bot s’est authentifié correctement. Ensuite, depuis un autre compte, publiez un tweet qui mentionne le bot avec !ping (par exemple @your_bot !ping) et vérifiez qu’il répond avec Pong! 🤖 X Bot working correctly! sur X en quelques minutes. Les mentions publiées avant le démarrage du bot sont ignorées.

Aller plus loin

Les extraits ci-dessous complètent index.js : ajoutez-les au fichier et appelez-les là où votre bot en a besoin.

Surveillance de hashtags

Publications programmées

Limitation de débit

X (Twitter) applique des limites de débit strictes. Mettez en place des contrôles pour éviter de dépasser ces limites :

Gestion des erreurs

Ressources supplémentaires

Pour approfondir vos connaissances sur le développement de bots X avec twitter-api-v2, consultez la documentation officielle de la bibliothèque twitter-api-v2. La documentation fournit des guides détaillés, des tutoriels avancés et des références complètes de l’API pour maximiser votre implémentation. Consultez également :

Prochaines étapes

L'application ne démarre pas

Corrigez les modules manquants, les erreurs de mémoire et les autres échecs au démarrage.

Variables d'environnement

Gérez les identifiants de votre bot et vos autres secrets.

Runtime Node.js

Comment Square Cloud exécute les applications Node.js.

Contactez-nous

Si vous rencontrez toujours des difficultés techniques, notre équipe de support spécialisée est disponible pour vous aider. Contactez-nous et nous serons ravis de vous aider à résoudre tout problème. La qualité du support compte pour beaucoup dans la note que les développeurs donnent à Square Cloud, 4,9/5 sur 402 avis sur Google et Trustpilot.