Documentation ServerBoost

Guide d'utilisation et referencement serveur

Cette documentation explique l'API vote, les endpoints publics et les bonnes pratiques pour integrer correctement ton serveur prive sans erreurs de suivi.

Test API Endpoints Inscrire un serveur

Essai (token + IP)

Teste uniquement GET /api/v1/servers/<SERVER_TOKEN>/votes/<IP>. Ã‡a nâ€™ajoute aucun vote : câ€™est une route de lecture.

URL principal : https://localhost

SERVER_TOKEN

IP

/api/v1/servers/<SERVER_TOKEN>/votes/<IP>

{ "hint": "Clique sur Testerâ€¦" }

InterprÃ©tation :
success: true â†’ lâ€™IP est en cooldown (attendre next_vote_seconds)
success: false â†’ pas de vote rÃ©cent, vote possible

Pass-through : si une rÃ¨gle â€œAdvancedâ€ a lâ€™option Pass-through, la rÃ©ponse reste 200 et un champ firewall est injectÃ©.

Exemples tÃ©lÃ©chargeables (owners)

Exemples prÃªts Ã lâ€™emploi pour vÃ©rifier un vote et crÃ©diter des coins via SQL (requÃªtes prÃ©parÃ©es). Pense Ã rendre la rÃ©compense idempotente (une seule fois par vote/IP/pÃ©riode).

TÃ©lÃ©charger lâ€™exemple PHP TÃ©lÃ©charger lâ€™exemple JS

Ces exemples sont gÃ©nÃ©riques. Adapte lâ€™accÃ¨s DB, les noms de tables/colonnes et la logique de vÃ©rification selon ton serveur.

Endpoints

Tous les endpoints ci-dessous sont disponibles en GET et utilisent le mÃªme token serveur. Le firewall â€œadvancedâ€ sâ€™applique via le contexte server-api.

Langage

curl -s "/api/v1/servers/<SERVER_TOKEN>/votes/1.2.3.4"

fetch("/api/v1/servers/<SERVER_TOKEN>/votes/1.2.3.4")
  .then(r => r.json())
  .then(console.log)
  .catch(console.error);

const res = await fetch("/api/v1/servers/<SERVER_TOKEN>/votes/1.2.3.4");
console.log(await res.json());

import requests
r = requests.get("/api/v1/servers/<SERVER_TOKEN>/votes/1.2.3.4", timeout=10)
print(r.json())

<?php
$ch = curl_init("/api/v1/servers/<SERVER_TOKEN>/votes/1.2.3.4");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
echo curl_exec($ch);
curl_close($ch);

using var http = new HttpClient();
var json = await http.GetStringAsync("/api/v1/servers/<SERVER_TOKEN>/votes/1.2.3.4");
Console.WriteLine(json);

var client = java.net.http.HttpClient.newHttpClient();
var req = java.net.http.HttpRequest.newBuilder()
  .uri(java.net.URI.create("/api/v1/servers/<SERVER_TOKEN>/votes/1.2.3.4"))
  .GET().build();
var res = client.send(req, java.net.http.HttpResponse.BodyHandlers.ofString());
System.out.println(res.body());

package main
import ("fmt"; "io"; "net/http")
func main() {
  resp, _ := http.Get("/api/v1/servers/<SERVER_TOKEN>/votes/1.2.3.4")
  defer resp.Body.Close()
  b, _ := io.ReadAll(resp.Body)
  fmt.Println(string(b))
}

require "net/http"
uri = URI("/api/v1/servers/<SERVER_TOKEN>/votes/1.2.3.4")
puts Net::HTTP.get(uri)

Response

{
  "success": true,
  "data": {
    "username": null,
    "voted_at": 1765755290,
    "is_connected": true,
    "is_subscriber": false,
    "next_vote_seconds": 3803
  }
}

{
  "success": false,
  "message": "Pas ou dÃ©jÃ  votÃ©",
  "data": {
    "username": null,
    "voted_at": null,
    "is_connected": false,
    "is_subscriber": false,
    "next_vote_seconds": 0
  }
}

Infos

VÃ©rifie si une IP est en cooldown (fenÃªtre 24h).

Firewall (pass-through) : si une rÃ¨gle correspond, tu peux recevoir en plus : {"firewall":{"error":"...","reason":"adv_rate_limit","retryAfterSec":30,"ruleId":"ar_xxx"}}

Langage

curl -s "/api/v1/servers/<SERVER_TOKEN>/statistics"

fetch("/api/v1/servers/<SERVER_TOKEN>/statistics")
  .then(r => r.json())
  .then(console.log)
  .catch(console.error);

const res = await fetch("/api/v1/servers/<SERVER_TOKEN>/statistics");
console.log(await res.json());

import requests
r = requests.get("/api/v1/servers/<SERVER_TOKEN>/statistics", timeout=10)
print(r.json())

<?php
$ch = curl_init("/api/v1/servers/<SERVER_TOKEN>/statistics");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
echo curl_exec($ch);
curl_close($ch);

using var http = new HttpClient();
var json = await http.GetStringAsync("/api/v1/servers/<SERVER_TOKEN>/statistics");
Console.WriteLine(json);

var client = java.net.http.HttpClient.newHttpClient();
var req = java.net.http.HttpRequest.newBuilder()
  .uri(java.net.URI.create("/api/v1/servers/<SERVER_TOKEN>/statistics"))
  .GET().build();
var res = client.send(req, java.net.http.HttpResponse.BodyHandlers.ofString());
System.out.println(res.body());

package main
import ("fmt"; "io"; "net/http")
func main() {
  resp, _ := http.Get("/api/v1/servers/<SERVER_TOKEN>/statistics")
  defer resp.Body.Close()
  b, _ := io.ReadAll(resp.Body)
  fmt.Println(string(b))
}

require "net/http"
uri = URI("/api/v1/servers/<SERVER_TOKEN>/statistics")
puts Net::HTTP.get(uri)

Response

{
  "success": true,
  "data": {
    "server": { "id": 123, "slug": "mon-serveur", "name": "Mon Serveur" },
    "rank": 7,
    "votes_total": 1234,
    "votes_month": 56,
    "clicks_month": 789,
    "reviews_total": 12,
    "rating_avg": 4.6
  }
}

Infos

Statistiques publiques (rang, votes total/mois, clics mois, avis total, moyenne).

Langage

curl -s "/api/v1/servers/<SERVER_TOKEN>/subscribers"

fetch("/api/v1/servers/<SERVER_TOKEN>/subscribers")
  .then(r => r.json())
  .then(console.log)
  .catch(console.error);

const res = await fetch("/api/v1/servers/<SERVER_TOKEN>/subscribers");
console.log(await res.json());

import requests
r = requests.get("/api/v1/servers/<SERVER_TOKEN>/subscribers", timeout=10)
print(r.json())

<?php
$ch = curl_init("/api/v1/servers/<SERVER_TOKEN>/subscribers");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
echo curl_exec($ch);
curl_close($ch);

using var http = new HttpClient();
var json = await http.GetStringAsync("/api/v1/servers/<SERVER_TOKEN>/subscribers");
Console.WriteLine(json);

var client = java.net.http.HttpClient.newHttpClient();
var req = java.net.http.HttpRequest.newBuilder()
  .uri(java.net.URI.create("/api/v1/servers/<SERVER_TOKEN>/subscribers"))
  .GET().build();
var res = client.send(req, java.net.http.HttpResponse.BodyHandlers.ofString());
System.out.println(res.body());

package main
import ("fmt"; "io"; "net/http")
func main() {
  resp, _ := http.Get("/api/v1/servers/<SERVER_TOKEN>/subscribers")
  defer resp.Body.Close()
  b, _ := io.ReadAll(resp.Body)
  fmt.Println(string(b))
}

require "net/http"
uri = URI("/api/v1/servers/<SERVER_TOKEN>/subscribers")
puts Net::HTTP.get(uri)

Response

{
  "success": true,
  "data": [
    { "id":"sub_abc", "username":"player", "plan":"premium", "active":true, "visible":true, "createdAt":"2025-12-15T00:00:00.000Z" }
  ]
}

Infos

Langage

curl -s "/api/v1/servers/<SERVER_TOKEN>/voters"

fetch("/api/v1/servers/<SERVER_TOKEN>/voters")
  .then(r => r.json())
  .then(console.log)
  .catch(console.error);

const res = await fetch("/api/v1/servers/<SERVER_TOKEN>/voters");
console.log(await res.json());

import requests
r = requests.get("/api/v1/servers/<SERVER_TOKEN>/voters", timeout=10)
print(r.json())

<?php
$ch = curl_init("/api/v1/servers/<SERVER_TOKEN>/voters");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
echo curl_exec($ch);
curl_close($ch);

using var http = new HttpClient();
var json = await http.GetStringAsync("/api/v1/servers/<SERVER_TOKEN>/voters");
Console.WriteLine(json);

var client = java.net.http.HttpClient.newHttpClient();
var req = java.net.http.HttpRequest.newBuilder()
  .uri(java.net.URI.create("/api/v1/servers/<SERVER_TOKEN>/voters"))
  .GET().build();
var res = client.send(req, java.net.http.HttpResponse.BodyHandlers.ofString());
System.out.println(res.body());

package main
import ("fmt"; "io"; "net/http")
func main() {
  resp, _ := http.Get("/api/v1/servers/<SERVER_TOKEN>/voters")
  defer resp.Body.Close()
  b, _ := io.ReadAll(resp.Body)
  fmt.Println(string(b))
}

require "net/http"
uri = URI("/api/v1/servers/<SERVER_TOKEN>/voters")
puts Net::HTTP.get(uri)

Response

{
  "success": true,
  "data": [
    { "username": "player", "ip": "1.2.*.*", "votes": 12 }
  ]
}

Infos

Erreurs & codes

200 : succÃ¨s (ou â€œsuccess:falseâ€ selon lâ€™endpoint).

400 : requÃªte invalide.

404 : serveur introuvable / banni / token invalide.

500 : erreur serveur.