Discord   Twitter

API

Retrouvez toutes les informations relatives au fonctionnement de l'API

  Instructions générales

Notre API vous permet, grâce à une simple requête, de savoir si un joueur a voté pour votre serveur en toute simplicité.
Vous retrouverez sur cette page toutes les informations nécessaires à la mise en place d'un tel système afin que vous puissiez l'intégrer facilement à votre système.

Afin de préserver la qualité de ce service, il vous sera demandé de n'exécuter des requêtes de façon modérée, seulement quand cela est nécessaire.

  Comment savoir si un joueur a voté ?

Généralités

L'adresse ci-dessous correspond à l'adresse à laquelle vous devez adresser votre requête.

https://www.liste-serveur.fr/api/hasVoted/{secret}/{username,ipAdress}

Cette URL contient deux variables que vous devrez modifier en fonction de votre serveur et de l'utilisateur que vous souhaitez vérifier. Pour ce faire, vous trouverez la variable {secret} au sein de la page de gestion des serveurs. Pour ce qui est de la seconde variable {username,ipAdress}, vous avez ici le choix d'utiliser le Pseudo du joueur ou bien son adresse IP.

Exemples d'URL valides :
  https://www.liste-serveur.fr/api/hasVoted/358bf0af9415554f7c32426f405c7b7f/MedusePinceau32 (Pseudo)
  https://www.liste-serveur.fr/api/hasVoted/358bf0af9415554f7c32426f405c7b7f/51.158.100.247 (Adresse IP)

Exemple d'utilisation de l'API en PHP :

On récupère ici le résultat de la requête que l'on stocke dans une variable. Le résultat est ensuite converti en tableau par l'interprétation du JSON fourni par l'API. On peut ensuite exploiter les différentes valeurs retournées :

/*
 *  Liste-Serveur.fr
 *
 *  Résultat retourné par l'API :
 {
  "hasVoted": true, // Valeur toujours disponible
  "lastVote": 1579024085, // Valeur retournée uniquement si le joueur a déjà voté au moins une fois
  "nextVote": 10794 // Valeur retournée si le joueur ne peut pas encore voter
 }
 */

$result = file_get_contents("https://www.liste-serveur.fr/api/hasVoted/358bf0af9415554f7c32426f405c7b7f/MedusePinceau32");
$jsonDecoded = json_decode($result, true);
if (isset($jsonDecoded['lastVote'])) {
  echo $jsonDecoded['lastVote']; // Affiche le timestamp du dernier vote
} else {
  echo "Le joueur n'a jamais voté";
}

if (isset($jsonDecoded['nextVote'])) {
  echo $jsonDecoded['nextVote']; // Affiche le temps restant avant le prochain vote (timestamp)
} elseif (isset($jsonDecoded['lastVote'])) {
  echo "Le joueur peut de nouveau voter";
}

if ($jsonDecoded['hasVoted'] === true) {
  echo "Le joueur a bien voté";
} elseif (isset($jsonDecoded['lastVote'])) {
  echo "Le joueur n'a pas voté";
}

  Vous utilisez un CMS ou Votifier ?

Vous utilisez un CMS :

Si vous utilisez un CMS, et que ce dernier possède un système permettant de gérer les votes, dans ce cas, il vous sera très simple d'y ajouter votre nouvelle page fraichement créée.

Pour ce faire, il vous faudra simplement récupérer le token de votre serveur. Ce dernier est visible sur la page de gestion des serveurs.
Ensuite, une fois que vous avez ce token, il vous suffit de suivre les instructions fournies par le CMS que vous utilisez.

Le CMS que vous utilisez ne supporte pas notre site ? N'hésitez pas à nous contacter.


Vous utilisez Votifier :

Afin de pouvoir établir une liason Votifier entre votre serveur et notre site, il vous faudra compléter la page de configuration de Votifier. Pour y accéder, il vous suffit d'aller sur la page de gestion des serveurs, puis de cliquer sur le bouton Votifier en face du serveur concerné.

Si vous utilisez le protocole V1 de Votifier, dans ce cas, le champ token ne sera pas à remplir. Néanmoins si le plugin que vous utilisez supporte le protocole V2 (et ce même s'il supporte également la V1), il vous sera demandé de compléter tous les champs. Notre site privilégiera toujours une connexion via le protocole V2 si celui-ci est disponible, pour des raisons de sécurité.