Introduction
Pour développer et héberger 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 payant 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.
Application du bot sur X
Accéder au Developer Portal
- Rendez-vous sur le X Developer Portal.
- Connectez-vous avec votre compte X (Twitter).
- Si c’est votre première fois, complétez le processus de demande d’accès développeur.
Création du projet
- Dans le tableau de bord, cliquez sur “Create Project”.
- Choisissez un nom pour votre projet (par ex. “Square Cloud Bot”).
- Sélectionnez le cas d’usage le plus approprié (par ex. “Making a bot”).
- Fournissez une description détaillée de votre bot.
- Confirmez la création du projet.
Configuration de l'application
- Au sein du projet créé, cliquez sur “Create App”.
- Définissez un nom unique pour votre application.
- Confirmez la création de l’application.
- Notez l’App ID généré pour référence future.
Génération des clés d'API
- Accédez à la section “Keys and tokens” de votre application.
- Dans la section “Consumer Keys”, cliquez sur “Regenerate” pour générer :
- API Key (Consumer Key)
- API Secret Key (Consumer Secret)
- Important : Copiez et enregistrez ces clés immédiatement, car vous ne pourrez plus les consulter par la suite.
Configuration des permissions
- Rendez-vous dans la section “App permissions”.
- Cliquez sur “Edit” pour modifier les permissions.
- Sélectionnez “Read and write” pour permettre à votre bot de publier des tweets.
- Si nécessaire, sélectionnez “Read and write and Direct message” pour la fonctionnalité de DM.
- Enregistrez les modifications.
Génération des jetons d'accès
- Retournez dans la section “Keys and tokens”.
- Dans la section “Access Token and Secret”, cliquez sur “Generate”.
- Confirmez la génération des jetons.
- Copiez et enregistrez :
- Access Token
- Access Token Secret
- Attention : Ces jetons ne peuvent plus être consultés après avoir fermé la page.
Vérification des identifiants
- Confirmez que vous disposez des 4 identifiants requis :
- API Key (Consumer Key)
- API Secret Key (Consumer Secret)
- Access Token
- Access Token Secret
- Conservez ces identifiants dans un endroit sécurisé
- Important : Ne partagez ni n’exposez jamais publiquement ces identifiants
Développement du projet
- 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.
- Initialisation du projet : Créez un nouveau projet Node.js en exécutant :
Terminal
- Installation des dépendances : Installez les bibliothèques requises pour le bot :
Terminal
- Configuration des variables d’environnement : Créez un fichier
.envpour stocker vos identifiants de manière sécurisée :
.env
- Création du fichier principal : Développez le fichier
index.jsavec la structure de base du bot :
index.js
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.Variables d'environnement
Variables d'environnement
Sécurité : N’incluez jamais vos identifiants d’API directement dans le code. Utilisez toujours des variables d’environnement sur Square Cloud.
API_KEY: Votre clé d’API XAPI_SECRET_KEY: Votre clé secrète d’API XACCESS_TOKEN: Votre jeton d’accèsACCESS_TOKEN_SECRET: Votre secret de jeton d’accès
Via le tableau de bord
Accéder à la page d'upload
Accédez à la page d’upload et téléversez le fichier zip de votre projet.
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.
Si vous téléversez un projet web, veillez à sélectionner « Publication Web » et à définir un sous-domaine pour votre projet.
Via la CLI
Pour utiliser cette méthode, vous devez créer un fichier de configuration nommésquarecloud.app à la racine de votre projet. Ce fichier contiendra la configuration nécessaire à votre projet.
En savoir plus : comment créer le fichier de configuration pour Square Cloud.
Le fichier squarecloud.app est un fichier de configuration qui servira à configurer votre application ; il sera utilisé pour définir votre environnement.
Installer la CLI
Tout d’abord, vous devez avoir la CLI installée dans votre environnement. Si ce n’est pas encore le cas, exécutez la commande suivante dans votre terminal :Si vous l’avez déjà, nous vous recommandons de la mettre à jour. Pour cela, exécutez la commande suivante dans votre terminal :
- Windows
- Linux, macOS et WSL
S'authentifier
Maintenant, pour vous authentifier et utiliser les autres commandes de la CLI, vous trouverez votre clé d’autorisation ici en cliquant sur « Request API Key ». Après avoir obtenu votre clé d’autorisation, exécutez la commande suivante :
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 :- Documentation officielle de l’API X
- Politiques d’utilisation de l’API X
- Guide des bonnes pratiques pour les bots


