Documentation API TopServ

v1.0

Bienvenue dans la documentation de l'API TopServ. Cette API permet d'accéder aux données des serveurs de jeux et aux fonctionnalités de vote.

URL de base

Tous les points d'accès de l'API sont relatifs à :

https://api.topserv.io/v1

Points d'accès

GET /votes/{serverId}/check-ip/{ipAddress}

Vérifie si une adresse IP a déjà voté pour un serveur au cours des 2 dernières heures.

Paramètres :

Nom Type Description
serverId entier ID du serveur
ipAddress chaîne Adresse IP à vérifier

Réponse :

{
    "canVote": true|false,
    "hasVoted": true|false,
    "lastVote": "2023-05-15T14:30:00Z", // Uniquement si hasVoted est true
    "message": "Cette IP peut voter." // Ou message d'erreur
}

GET /votes/{serverId}/check-username/{username}

Vérifie si un nom d'utilisateur a déjà voté pour un serveur au cours des 2 dernières heures.

Paramètres :

Nom Type Description
serverId entier ID du serveur
username chaîne Nom d'utilisateur à vérifier

Réponse :

{
    "canVote": true|false,
    "hasVoted": true|false,
    "lastVote": "2023-05-15T14:30:00Z", // Uniquement si hasVoted est true
    "message": "Ce nom d'utilisateur peut voter." // Ou message d'erreur
}

GET /server/status/{serverId}

Obtient des informations détaillées sur un serveur, y compris le jeu, les tags, les captures d'écran et le statut en ligne.

Paramètres :

Nom Type Description
serverId entier ID du serveur

Réponse :

{
    "id": 123,
    "name": "Nom du serveur",
    "slug": "nom-du-serveur",
    "description": "Description du serveur...",
    "short_description": "Description courte",
    "ip_address": "play.example.com",
    "port": 25565,
    "game": {
        "id": 1,
        "name": "Minecraft",
        "slug": "minecraft",
        "icon": "https://example.com/icon.png"
    },
    "status": {
        "online": true,
        "players_online": 42,
        "max_players": 100,
        "last_updated": "2023-05-15T14:30:00Z"
    },
    "media": {
        "banner_image": "https://example.com/banner.jpg",
        "logo_image": "https://example.com/logo.png",
        "screenshots": [
            "https://example.com/screenshot1.jpg",
            "https://example.com/screenshot2.jpg"
        ]
    },
    "links": {
        "website": "https://example.com",
        "discord": "example"
    },
    "votes": {
        "total": 1500,
        "recent": 75
    },
    "tags": ["Survie", "PvP", "Économie"],
    "featured": {
        "is_featured": true,
        "featured_slot": 1,
        "featured_until": "2023-06-15"
    },
    "created_at": "2023-01-15T10:00:00Z",
    "updated_at": "2023-05-15T14:30:00Z"
}