Configurer le webhook Top.gg sur Square Cloud

​

Introduction

• Ce guide suppose que vous avez un bot approuvé sur top.gg et que vous utilisez Node.js ou Python pour votre projet.
• Ensuite, vous devrez créer un compte sur Square Cloud, ce que vous pouvez faire depuis la page d’inscription. Vous pouvez utiliser votre e-mail pour créer un compte.
• Enfin, vous devez disposer d’un plan payant actif sur votre compte. Vous pouvez consulter nos plans et en acheter un selon vos besoins ici.

​

Configuration de l’environnement

npm init -y

npm install @top-gg/sdk express

pip install flask
pip install waitress

​

Configuration du projet

• Rendez-vous sur votre profil Top.gg ici.
• Cliquez sur « edit » sur le bot pour lequel vous voulez recevoir les notifications de votes.
• Sous « GENERAL », choisissez l’option « webhook ».
• Définissez l’authentification du webhook dans « Authorization ». Dans cet exemple, nous avons utilisé « myappsquare ».

// Import libraries
const Topgg = require("@top-gg/sdk");
const express = require("express");

// Create Express app and Top.gg webhook instances
const app = express();
const webhook = new Topgg.Webhook("YOUR_AUTHORIZATION_TOKEN");

// Define route for '/topgg' endpoint (POST requests)
app.post("/topgg", webhook.listener((vote) => {
  // Log vote received message with user ID
  console.log(`Vote received successfully! User ID: ${vote.user}`);
}));

// Start server on port 80 (default HTTP)
app.listen(80);

# Import the necessary libraries
import logging
import json
from waitress import serve
from flask import Flask, request, abort

# Create an instance of the Flask app
app = Flask(__name__)

# Define your authorization token
AUTH_TOKEN = 'YOUR_AUTHORIZATION'

# Define a route for the '/topgg' endpoint that accepts POST requests
@app.route("/topgg", methods=["POST"])
def hook():
    # Check the authorization header
    auth = request.headers.get('Authorization')
    if auth != AUTH_TOKEN:
        logging.error('Access denied')
        abort(401)  # Unauthorized

    # Convert the request data from bytes to a JSON dictionary
    data = json.loads(request.data)
    # Print the ID of the user who voted
    print(f'Vote received successfully! User ID: {data["user"]}')
    # Return a response with the string "Data received" and status 200 to indicate that the request was processed successfully
    return "Data received"

# Check if this script is being run directly and not imported as a module
if __name__ == "__main__":
    # Set the log message format to exclude the log level
    logging.basicConfig(format='%(message)s', level=logging.INFO)
    # Serve our Flask app on port 80 and listen on all network interfaces
    serve(app, host="0.0.0.0", port=80)

​

Créer le fichier de configuration squarecloud

​

Envoyer votre application sur Square Cloud

• Envoi via le Dashboard
• Envoi via la CLI

Accédez au Dashboard Square Cloud et envoyez les fichiers de votre projet.

1

Première étape

Tout d’abord, vous devez avoir la CLI installée dans votre environnement. Si vous ne l’avez pas encore, exécutez la commande suivante dans votre terminal :

npm install -g @squarecloud/cli

Si vous l’avez déjà, nous vous recommandons de la mettre à jour. Pour ce faire, exécutez la commande suivante dans votre terminal :

• Windows
• Linux, macOS et WSL

squarecloud update

curl -fsSL https://cli.squarecloud.app/install | bash

2

Deuxième étape

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 :

squarecloud auth login 

3

Troisième étape

Enfin, pour déployer votre application sur Square Cloud à l’aide de la CLI, vous devez exécuter la commande suivante en passant le chemin de votre fichier zip :

squarecloud upload zip

​

Lancer les tests

• Pour le code JavaScript que nous avons créé avec app.post("/topgg", webhook.listener((vote) => {...}), la route qui recevra les votes est « /topgg ». Donc, si votre site est « mysite.squareweb.app », vous devez mettre « mysite.squareweb.app/topgg » comme Webhook URL.
• Pour le code Python que nous avons créé avec @app.route("/topgg", methods=["POST"]), la route qui recevra les votes est également « /topgg ». Ainsi, l’URL du webhook serait la même « mysite.squareweb.app/topgg ».

​

Dépannage

​

Contactez-nous