L'API quésaco ?

API (Application Programming Interface) est un outil pour toutes les personnes souhaitant recueillir des informations sur les votes que les utilisateurs effectuent. (Aucune information sensible n'est divulguée telle que les mots de passe, les adresses email ...)

Fonctionnement:

L'API retourne un message sous forme JSON qui peut-être lue / utiliser de plusieurs methods, ici nous utiliserons le language PHP.

Pour obtenir ce message vous devez entrer des informations dans L'URL ci-contre avec la method GET via file_get_contents() ou curl():
https://liste-serv-minecraft.fr/api/check

Note: L'API ne supporte pas les UUID pour le moments

Les Arguments:

Argument:	Description:
1) server ^*	Cible le serveur à vérifier via son id
2) ip ^*	Permets de vérifier le vote d'un utilisateur avec l'ip fournit
3) username ^*	Permets de vérifier le vote d'un utilisateur avec le pseudo fournit
4) method	Opérateurs logiques si l'argument 2 et 3 sont présents. Valeur: AND ou OR

^*: Arguments obligatoires
^*: Un des deux Arguments est obligatoire.

Les "Status":

status:	Description:
100	Accés a la base de données imposible
200	Résultat trouvé
300	Requette incorecte (voir argument text)
400	Aucun résultat
500	Erreur interne

Exemple:

Note: Vous avez le choix d'utiliser curl() ou file_get_contents() bien qu'il soit conseiller d'utiliser curl.

Cas 1: Recherche pour un seul argument

Le joueur: XxMichelxX à voté pour le serveur 95 avec l'ip 100.100.100.100

On souhaite trouver toute les information du vote pour le serveur 95 avec l'ip 100.100.100.100 ou avec le pseudo XxMichelxX:

<?php

$url = "https://liste-serv-minecraft.fr/api/check?server=95&ip=100.100.100.100";

// ou $url = "https://liste-serv-minecraft.fr/api/check?server=95&username=XxMichelxX";

if(function_exists('curl_version')){
	$curl = curl_init($url);
	curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
	curl_setopt($curl, CURLOPT_TIMEOUT,1); /*timeout modifiable (durée en seconde)*/
	$response = curl_exec($curl);
	curl_close($curl);
}else{
	$response = file_get_contents($url);
     }
	 
$var = json_decode($response,true); //Permets de stocker les données dans un array.

?>


//dans ce cas les variables valent:

$var["status"] = 200
$var["text"] = "resultat trouver"

$var["id_vote"] = 86 //id unique du vote
$var["datetime_vote_start"] = "2016-08-20 17:33:56" //horaire de début du vote
$var["datetime_vote_end"] = "2016-08-20 20:33:56" //horaire de fin du vote
$var["username"] = "XxMichelxX" //pseudo entré par l'utilisateur lors du vote

Cas 2: Recherche pour deux argument

Le joueur: XxMichelxX à voté pour le serveur 95 avec l'ip 100.100.100.100

On shouaite trouver toute les information du vote pour le serveur 95 avec l'ip 100.100.100.100 et le pseudo XxMichelxX
Puis on shouaite trouver toute les information du vote pour le serveur 95 avec l'ip 100.100.100.100 ou le pseudo XxMichelxX


<?php
$url = "https://liste-serv-minecraft.fr/api/check?server=95&username=XxMichelxX&ip=100.100.100.100&method=AND";

//	la méthode AND va retourner un résultat seulement si le pseudo et l'ip correspondent à un vote
//
//			Deuxième méthode:
//
//  $url = "https://liste-serv-minecraft.fr/api/check?server=95&username=XxMichelxX&ip=100.100.100.100&method=OR";
//
//  la méthode OR va retourner un résultat si le pseudo ou l'ip correspondent à un vote


if(function_exists('curl_version')){
	$curl = curl_init($url);
	curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
	curl_setopt($curl, CURLOPT_TIMEOUT,1); /*timeout modifiable (durée en seconde)*/
	$response = curl_exec($curl);
	curl_close($curl);
}else{
	$response = file_get_contents($url);
     }
	 
$var = json_decode($response,true); //Permets de stocker les données dans un array.

?>

//dans ce cas les variables valent:

$var["status"] = 200
$var["text"] = "resultat trouver"

$var["id_vote"] = 86 //id unique du vote
$var["datetime_vote_start"] = "2016-08-20 17:33:56" //horaire de début du vote
$var["datetime_vote_end"] = "2016-08-20 20:33:56" //horaire de fin du vote
$var["username"] = "XxMichelxX" //pseudo entré par l'utilisateur lors du vote

Votifier:

Si vous n'avez pas les capacités ou les moyens de réaliser un code PHP vous pouvez toujours vérifier un vote d'un utilisateur grace au plugin Votifier.
Votifier est un plugin bukkit permettant de vérifier le vote d'un utilisateur via son pseudo sur plusieurs sites de vote utilisant ce protocole.

Installation de votifier:

- Rendez-vous sur cette page: https://dev.bukkit.org/projects/votifier.
- Télécharger le plugin puis installer le sur votre serveur.
- Une fois installé redémarrez votre serveur.
- Ensuite allez dans le dossier plugins/votifier/rsa/ de votre serveur.
- Récupérez le contenue du fichier public key (à l'aide de bloc-notes ou un éditeur de texte)..
- Enfin allez sur la page "Mon compte" de notre site puis éditer votre serveur et ajoutez le contenu récupérer ci-dessus dans la case "clef publique".
Ainsi que le port de votifier "présent dans le fichier plugins/votifier/config.yml" (par défaut 8192).

Note: Votifier permet simplement de vérifier un vote, pour donner une récompense / faire un classement de vote il faut installer d'autre plugin fonctionnant avec votifier.

INFO: L'utilisateur doit écrire son pseudo minecraft l'or de son vote pour que votifier fonctionne. (Et doit être connecté au serveur s'il y a des récompenses à récupérer).

Tester la compatibilité de Votifier:

Vous pouvez tester la compatibilité de votifier avec cette page: Testeur de compatibilité avec votifier
(vous devez être connecté pour utiliser le testeur).