Top.gg-Webhook auf Square Cloud konfigurieren

​

Einführung

• Diese Anleitung setzt voraus, dass du einen genehmigten Bot auf top.gg hast und für dein Projekt entweder Node.js oder Python verwendest.
• Als Nächstes musst du ein Konto bei Square Cloud erstellen, was über die Registrierungsseite möglich ist. Du kannst deine E-Mail-Adresse verwenden, um ein Konto zu erstellen.
• Schließlich musst du einen aktiven kostenpflichtigen Plan in deinem Konto haben. Du kannst unsere Pläne ansehen und einen nach deinen Bedürfnissen hier erwerben.

​

Einrichtung der Umgebung

npm init -y

npm install @top-gg/sdk express

pip install flask
pip install waitress

​

Einrichtung des Projekts

• Gehe zu deinem Top.gg-Profil hier.
• Klicke auf “edit” bei dem Bot, für den du Benachrichtigungen über Votes erhalten möchtest.
• Wähle unter “GENERAL” die Option “webhook”.
• Lege die Webhook-Authentifizierung unter “Authorization” fest. In diesem Beispiel haben wir “myappsquare” verwendet.

// 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)

​

Erstellen der squarecloud-Konfigurationsdatei

​

Deine Anwendung auf Square Cloud hochladen

• Dashboard-Upload
• CLI-Upload

Rufe das Square Cloud Dashboard auf und lade deine Projektdateien hoch.

1

Erster Schritt

Zuerst musst du die CLI in deiner Umgebung installiert haben. Falls du sie noch nicht hast, führe den folgenden Befehl in deinem Terminal aus:

npm install -g @squarecloud/cli

Falls du sie bereits hast, empfehlen wir, sie zu aktualisieren. Führe dazu den folgenden Befehl in deinem Terminal aus:

• Windows
• Linux, macOS und WSL

squarecloud update

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

2

Zweiter Schritt

Um dich nun zu authentifizieren und andere CLI-Befehle zu verwenden, findest du deinen Autorisierungsschlüssel hier, indem du auf “Request API Key” klickst. Nachdem du deinen Autorisierungsschlüssel erhalten hast, führe den folgenden Befehl aus:

squarecloud auth login 

3

Dritter Schritt

Um deine Anwendung schließlich mit der CLI auf Square Cloud zu deployen, musst du den folgenden Befehl ausführen und dabei den Pfad deiner ZIP-Datei übergeben:

squarecloud upload zip

​

Tests starten

• Für den JavaScript-Code, den wir mit app.post("/topgg", webhook.listener((vote) => {...}) erstellt haben, ist die Route, die die Votes empfängt, “/topgg”. Wenn deine Website also “mysite.squareweb.app” ist, solltest du “mysite.squareweb.app/topgg” als Webhook URL eintragen.
• Für den Python-Code, den wir mit @app.route("/topgg", methods=["POST"]) erstellt haben, ist die Route, die die Votes empfängt, ebenfalls “/topgg”. Die Webhook URL wäre also dieselbe “mysite.squareweb.app/topgg”.

​

Fehlerbehebung

​

Kontaktiere uns