Notre API vous permet de récupérer des informations sur votre serveur ainsi que les informations de votes afin de les exploiter sur votre site internet.
Chaque API peut retourner son résultat sous 4 formats :
- texte: la valeur est retournée sous forme de texte simple (utile pour inclure la valeur dans un script)
- json: la valeur est retournée sous forme de code json (permet de l'inclure dans un script php par exemple)
- ajax: la valeur est retournée au format json et peut être lue depuis un script javascript (en ajax par exemple)
- jsonp: permet d'utiliser l'API en javascript depuis votre site, sans restriction XSS.
Il est possible de choisir le format de retour de l'api en ajoutant le paramètre "format" avec une des valeurs suivantes : text, json, ajax, jsonp.
Etat du serveur
Permet de savoir si votre serveur est en ligne ou hors-ligne.
Retourne un objet avec le paramètre is_online à true si le serveur est en ligne ou à false s'il est hors-ligne (ex: {"is_online": true}). En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Retourne un objet avec le paramètre is_online à true si le serveur est en ligne ou à false s'il est hors-ligne (ex: {"is_online": true}). En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code HTML / Ajax JQuery):
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
Etats du serveur: <span id="is_online">Chargement...</span>
<script type="text/javascript">
$(window).load(function()
{
$.get(
'http://bedrock.serveurs-minecraft.org/api/is_online.php',
{ id: XX, format: "ajax"},
function(data)
{
if (data.is_online)
$('#is_online').text(data.is_online ? 'En Ligne' : 'Hors Ligne');
else if (data.error)
$('#is_online').text(data.error);
});
});
</script>
La variable Javascript serveurs_minecraft_org_is_online est affectée à true si le serveur est en ligne, false s'il est hors-ligne ou à un objet contenant le message d'erreur en cas d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code HTML/Javascript):
<script type="text/javascript" src="http://bedrock.serveurs-minecraft.org/api/is_online.php?id=XX&format=jsonp"></script>
Etats du serveur: <span id="is_online"></span>
<script type="text/javascript">
window.onload = function () {
var elt = document.getElementById("is_online");
if (serveurs_minecraft_org_is_online === true)
elt.innerHTML = "En ligne";
else if (serveurs_minecraft_org_is_online === false)
elt.innerHTML = "Hors ligne";
else
elt.innerHTML = "Inconnu";
}
</script>
Nombre de joueurs
Permet de connaître le nombre de joueurs actuellement connectés sur votre serveur.
Retourne un objet avec le paramètre players_count contenant le nombre de joueurs actuellement connecté. En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code PHP):
<?php
$players_count = file_get_contents('http://bedrock.serveurs-minecraft.org/api/players_count.php?id=XX&format=json');
$slots_count = file_get_contents('http://bedrock.serveurs-minecraft.org/api/slots_count.php?id=XX&format=json');
$players_count = json_decode($players_count);
$slots_count = json_decode($slots_count);
if (isset($players_count->players_count) && isset($slots_count->slots_count))
echo "Nombre de joueurs actuellement en ligne: {$players_count->players_count}/{$slots_count->slots_count}";
else if (isset($players_count->error))
echo 'Erreur: ' . $players_count->error;
else if (isset($slots_count->error))
echo 'Erreur: ' . $slots_count->error;
else
echo 'Erreur Inconnue';
?>
Retourne un objet avec le paramètre players_count contenant le nombre de joueurs actuellement connecté. En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code HTML / Ajax JQuery):
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
Nombre de joueurs connectés : <span id="players_count">?</span> / <span id="slots_count">?</span>
<script type="text/javascript">
$(window).load(function()
{
$.get(
'http://bedrock.serveurs-minecraft.org/api/players_count.php',
{ id: XX, format: "ajax"},
function(data)
{
if (data.players_count)
$('#players_count').text(data.players_count);
else if (data.error)
$('#players_count').text(data.error);
});
$.get(
'http://bedrock.serveurs-minecraft.org/api/slots_count.php',
{ id: XX, format: "ajax"},
function(data)
{
if (data.slots_count)
$('#slots_count').text(data.slots_count);
else if (data.error)
$('#slots_count').text(data.error);
});
});
</script>
La variable Javascript serveurs_minecraft_org_players_count contient le nombre de joueurs actuellement connectés sur le serveur ou un objet contenant le message d'erreur en cas d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code HTML/Javascript):
<script type="text/javascript" src="http://bedrock.serveurs-minecraft.org/api/players_count.php?id=XX&format=jsonp"></script>
<script type="text/javascript" src="http://bedrock.serveurs-minecraft.org/api/slots_count.php?id=XX&format=jsonp"></script>
Nombre de joueurs connectés : <span id="players_count"></span> / <span id="slots_count"></span>
<script type="text/javascript">
window.onload = function () {
var players = document.getElementById("players_count");
var slots = document.getElementById("slots_count");
if (serveurs_minecraft_org_players_count >= 0 && serveurs_minecraft_org_slots_count >= 0)
{
players.innerHTML = serveurs_minecraft_org_players_count;
slots.innerHTML = serveurs_minecraft_org_slots_count;
}
else
{
players.innerHTML = '?';
slots.innerHTML = '?';
}
}
</script>
Nombre de slots
Permet de connaître le nombre de slots actuellement disponibles sur votre serveur.
Retourne un objet avec le paramètre slots_count contenant le nombre de slots disponible. En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code PHP):
<?php
$players_count = file_get_contents('http://bedrock.serveurs-minecraft.org/api/players_count.php?id=XX&format=json');
$slots_count = file_get_contents('http://bedrock.serveurs-minecraft.org/api/slots_count.php?id=XX&format=json');
$players_count = json_decode($players_count);
$slots_count = json_decode($slots_count);
if (isset($players_count->players_count) && isset($slots_count->slots_count))
echo "Nombre de joueurs actuellement en ligne: {$players_count->players_count}/{$slots_count->slots_count}";
else if (isset($players_count->error))
echo 'Erreur: ' . $players_count->error;
else if (isset($slots_count->error))
echo 'Erreur: ' . $slots_count->error;
else
echo 'Erreur Inconnue';
?>
Retourne un objet avec le paramètre slots_count contenant le nombre de slots disponible. En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code HTML / Ajax JQuery):
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
Nombre de joueurs connectés : <span id="players_count">?</span> / <span id="slots_count">?</span>
<script type="text/javascript">
$(window).load(function()
{
$.get(
'http://bedrock.serveurs-minecraft.org/api/players_count.php',
{ id: XX, format: "ajax"},
function(data)
{
if (data.players_count)
$('#players_count').text(data.players_count);
else if (data.error)
$('#players_count').text(data.error);
});
$.get(
'http://bedrock.serveurs-minecraft.org/api/slots_count.php',
{ id: XX, format: "ajax"},
function(data)
{
if (data.slots_count)
$('#slots_count').text(data.slots_count);
else if (data.error)
$('#slots_count').text(data.error);
});
});
</script>
La variable Javascript serveurs_minecraft_org_slots_count contient le nombre de slots actuellement disponibles sur le serveur ou un objet contenant le message d'erreur en cas d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code HTML/Javascript):
<script type="text/javascript" src="http://bedrock.serveurs-minecraft.org/api/players_count.php?id=XX&format=jsonp"></script>
<script type="text/javascript" src="http://bedrock.serveurs-minecraft.org/api/slots_count.php?id=XX&format=jsonp"></script>
Nombre de joueurs connectés: <span id="players_count"></span> / <span id="slots_count"></span>
<script type="text/javascript">
window.onload = function () {
var players = document.getElementById("players_count");
var slots = document.getElementById("slots_count");
if (serveurs_minecraft_org_players_count >= 0 && serveurs_minecraft_org_slots_count >= 0)
{
players.innerHTML = serveurs_minecraft_org_players_count;
slots.innerHTML = serveurs_minecraft_org_slots_count;
}
else
{
players.innerHTML = '?';
slots.innerHTML = '?';
}
}
</script>
Version
Permet de connaître le numéro de version de Minecraft accepté par votre serveur (tel qu'il est vu par bedrock.serveurs-minecraft.org).
Retourne un objet avec le paramètre version contenant la version de Minecraft du serveur. En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Retourne un objet avec le paramètre version contenant la version de Minecraft du serveur. En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code HTML / Ajax JQuery):
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
Version Minecraft: <span id="version">Chargement...</span>
<script type="text/javascript">
$(window).load(function()
{
$.get(
'http://bedrock.serveurs-minecraft.org/api/version.php',
{ id: XX, format: "ajax"},
function(data)
{
if (data.version)
$('#version').text(data.version);
else if (data.error)
$('#version').text(data.error);
});
});
</script>
La variable Javascript serveurs_minecraft_org_version contient la version de Minecraft du serveur ou un objet contenant le message d'erreur en cas d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code HTML/Javascript):
<script type="text/javascript" src="http://bedrock.serveurs-minecraft.org/api/version.php?id=XX&format=jsonp"></script>
Version Minecraft: <span id="version"></span>
<script type="text/javascript">
window.onload = function () {
var version = document.getElementById("version");
if (typeof serveurs_minecraft_org_version === 'string' || serveurs_minecraft_org_version instanceof String)
version.innerHTML = serveurs_minecraft_org_version;
else if (serveurs_minecraft_org_version.error)
version.innerHTML = 'Erreur: ' + serveurs_minecraft_org_version.error;
else
version.innerHTML = '?';
}
</script>
Présentation du serveur (MOTD)
Obtient le message de présentation du serveur (MOTD) converti au format HTML/UTF-8.
Retourne un objet avec le paramètre motd contenant le MOTD de votre serveur. En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code PHP):
<?php
$motd = file_get_contents('http://bedrock.serveurs-minecraft.org/api/motd.php?id=XX&format=json');
$motd = json_decode($motd);
if (isset($motd->motd))
echo "Présentation: {$motd->motd}";
else if (isset($motd->error))
echo 'Erreur: ' . $motd->error;
else
echo 'Erreur Inconnue';
?>
Retourne un objet avec le paramètre motd contenant le MOTD de votre serveur. En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code HTML / Ajax JQuery):
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
Présentation: <span id="motd"></span>
<script type="text/javascript">
$(window).load(function()
{
$.get(
'http://bedrock.serveurs-minecraft.org/api/motd.php',
{ id: XX, format: "ajax"},
function(data)
{
if (data.motd)
$('#motd').html(data.motd);
else if (data.error)
$('#motd').text(data.error);
});
});
</script>
La variable Javascript serveurs_minecraft_org_motd contient le MOTD de votre serveur ou un objet contenant le message d'erreur en cas d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code HTML/Javascript):
<script type="text/javascript" src="http://bedrock.serveurs-minecraft.org/api/motd.php?id=XX&format=jsonp"></script>
Présentation: <span id="motd"></span>
<script type="text/javascript">
window.onload = function () {
var motd = document.getElementById("motd");
if (typeof serveurs_minecraft_org_motd === 'string' || serveurs_minecraft_org_motd instanceof String)
motd.innerHTML = serveurs_minecraft_org_motd;
else if (serveurs_minecraft_org_motd.error)
motd.innerHTML = 'Erreur: ' + serveurs_minecraft_org_motd.error;
else
motd.innerHTML = '?';
}
</script>
Toutes les infos
Retourne l'ensemble des informations de votre serveur: adresse IP, statut en ligne/hors ligne, nombre de joueurs et de slots, version du serveur, temps de ping, icône et message de présentation (motd).
Retourne un objet avec l'ensemble des informations techniques de votre serveur. Exemple de valeur possible: {
"ip": "minecraft.exemple.fr",
"is_online": true,
"players_count": 12,
"slots_count": 100,
"version": "1.9.4",
"ping": 42,
"icon": "http:\/\/bedrock.serveurs-minecraft.org\/icones_serveur\/6212260588ec9a391e007d5ef392a6cd.png",
"motd": "Mon serveur Minecraft"
}
En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code PHP):
<?php
$server_infos = file_get_contents('http://bedrock.serveurs-minecraft.org/api/server_infos.php?id=XX&format=json');
$server_infos = json_decode($server_infos);
if (isset($server_infos->ip))
{
echo "Bienvenue sur le serveur <img src=\"{$server_infos->icon}\" width=\"64\" height=\"64\" /> {$server_infos->ip} en version {$server_infos->version}<br/>";
if ($server_infos->is_online)
echo "État du serveur: Online, {$server_infos->players_count}/{$server_infos->slots_count} (Ping: {$server_infos->ping})<br/>";
else
echo "État du serveur: Offline<br/>";
echo "Message de bienvenu: {$server_infos->motd}<br/>";
}
else if (isset($server_infos->error))
echo 'Erreur: ' . $server_infos->error;
else
echo 'Erreur Inconnue';
?>
Retourne un objet avec l'ensemble des informations techniques de votre serveur. Exemple de valeur possible: {
"ip": "minecraft.exemple.fr",
"is_online": true,
"players_count": 12,
"slots_count": 100,
"version": "1.9.4",
"ping": 42,
"icon": "http:\/\/bedrock.serveurs-minecraft.org\/icones_serveur\/6212260588ec9a391e007d5ef392a6cd.png",
"motd": "Mon serveur Minecraft"
}
En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code HTML / Ajax JQuery):
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
Présentation: Bienvenu sur le serveur <span id="server_icon"></span> <span id="server_ip">0.0.0.0</span> en version <span id="server_version"></span><br/>
État du serveur: <span id="server_status">Chargement...</span><br/>
Message de bienvenu: <span id="server_message">Chargement...</span><br/>
<script type="text/javascript">
$(window).load(function()
{
$.get(
'http://bedrock.serveurs-minecraft.org/api/server_infos.php',
{ id: XX, format: "ajax"},
function(data)
{
if (data.ip)
{
$('#server_ip').html(data.ip);
$('#server_version').html(data.version);
if (data.icon != null)
{
$('#server_icon').html('<img src="' + data.icon + '" width="64" height="64" />');
}
if (data.is_online)
{
$('#server_status').html('Online, ' +
data.players_count + '/' + data.slots_count +
' (Ping: ' + data.ping + ')');
}
else
{
$('#server_status').html("Offline");
}
$('#server_message').html(data.motd);
}
});
});
</script>
La variable Javascript serveurs_minecraft_org_server_infos contient l'ensemble des informations techniques de votre serveur. Exemple de valeur possible: {
"ip": "minecraft.exemple.fr",
"is_online": true,
"players_count": 12,
"slots_count": 100,
"version": "1.9.4",
"ping": 42,
"icon": "http:\/\/bedrock.serveurs-minecraft.org\/icones_serveur\/6212260588ec9a391e007d5ef392a6cd.png",
"motd": "Mon serveur Minecraft"
} En cas d'erreur un objet contenant le message d'erreur est retourné (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code HTML/Javascript):
<script type="text/javascript" src="http://bedrock.serveurs-minecraft.org/api/server_infos.php?id=XX&format=jsonp"></script>
Présentation: Bienvenu sur le serveur <span id="server_icon"></span> <span id="server_ip"></span> en version <span id="server_version"></span><br/>
État du serveur: <span id="server_status">Chargement...</span><br/>
Message de bienvenu: <span id="server_message">Chargement...</span><br/>
<script type="text/javascript">
window.onload = function () {
if (serveurs_minecraft_org_server_infos.ip)
{
document.getElementById("server_ip").innerHTML = serveurs_minecraft_org_server_infos.ip;
document.getElementById("server_version").innerHTML = serveurs_minecraft_org_server_infos.version;
if (serveurs_minecraft_org_server_infos.icon != null)
{
document.getElementById("server_icon").innerHTML =
'<img src="' + serveurs_minecraft_org_server_infos.icon + '" width="64" height="64" />';
}
if (serveurs_minecraft_org_server_infos.is_online)
{
document.getElementById("server_status").innerHTML = 'Online, ' +
serveurs_minecraft_org_server_infos.players_count + '/' + serveurs_minecraft_org_server_infos.slots_count +
' (Ping: ' + serveurs_minecraft_org_server_infos.ping + ')';
}
else
{
document.getElementById("server_status").innerHTML = "Offline";
}
document.getElementById("server_message").innerHTML = serveurs_minecraft_org_server_infos.motd;
}
}
</script>
Nombre de votes
Retourne le nombre de vote reçu pour votre serveur sur bedrock.serveurs-minecraft.org. Il est possible de spécifier une durée de recherche via le paramètre "period" qui peut prendre les valeurs suivantes:
day (nombre de votes depuis 24h)
week (nombre de votes depuis une semaine)
month (nombre de votes depuis un mois, c'est la valeur par defaut si period n'est pas spécifié)
all (tous les votes reçus depuis l'inscription du serveur sur le site)
Retourne un objet avec le paramètre votes contenant le nombre de vote reçu et avec le paramètre days contenant le nombre de jours prise en compte (ou -1 pour tous les votes).. En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code PHP):
<?php
$votes_count = file_get_contents('http://bedrock.serveurs-minecraft.org/api/votes_count.php?id=XX&period=XX&format=json');
$votes_count = json_decode($votes_count);
if (isset($votes_count->votes))
echo "Nombre de votes: {$votes_count->votes} votes reçus depuis {$votes_count->days} jours";
else if (isset($votes_count->error))
echo 'Erreur: ' . $votes_count->error;
else
echo 'Erreur Inconnue';
?>
Retourne un objet avec le paramètre votes contenant le nombre de vote reçu et avec le paramètre days contenant le nombre de jours prise en compte (ou -1 pour tous les votes).. En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code HTML / Ajax JQuery):
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
Nombre de votes reçus: <span id="votes_count">Chargement...</span>
<script type="text/javascript">
$(window).load(function()
{
$.get(
'http://bedrock.serveurs-minecraft.org/api/votes_count.php',
{ id: XX, format: 'ajax', period: 'XX'},
function(data)
{
if (data.votes)
$('#votes_count').html("Nombre de votes: " + data.votes + " votes reçus depuis " + data.days + " jours");
else if (data.error)
$('#votes_count').text(data.error);
});
});
</script>
La variable Javascript serveurs_minecraft_org_votes contient la nombre de votes reçus par votre serveur ou un objet contenant le message d'erreur en cas d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code HTML/Javascript):
<script type="text/javascript" src="http://bedrock.serveurs-minecraft.org/api/votes_count.php?id=XX&period=XX&format=jsonp"></script>
Nombre de votes reçus: <span id="votes_count"></span>
<script type="text/javascript">
window.onload = function () {
var votes_count = document.getElementById("votes_count");
if (typeof serveurs_minecraft_org_votes === 'string' || serveurs_minecraft_org_votes instanceof String)
votes_count.innerHTML = serveurs_minecraft_org_votes;
else if (serveurs_minecraft_org_votes.error)
votes_count.innerHTML = 'Erreur: ' + serveurs_minecraft_org_votes.error;
else
votes_count.innerHTML = '?';
}
</script>
Vérifier un vote
Vous permet de tester si l'IP spécifié a voté pour votre serveur durant les 5 dernières minutes sur bedrock.serveurs-minecraft.org. L'adresse IP a tester doit être indiqué via le paramètre "ip" (obligatoire). La durée de recherche peut être personnalisé via le paramètre "duration" (valeur en minute, optionnel, 5 minute par défaut).
Retourne 1 si le site a reçu un vote pour votre serveur provenant de l'IP spécifié dans le delai indiqué, ou 0 si aucun vote n'a été trouvé. -1 est retourné en cas d'erreur.
Exemple d'utilisation (code PHP):
<?php
$is_valid_vote = file_get_contents('http://bedrock.serveurs-minecraft.org/api/is_valid_vote.php?id=XX&ip=XX&duration=XX');
if ($is_valid_vote > 0)
echo "XX a voté pour le serveur durant les XX dernières minutes";
else if ($is_valid_vote == 0)
echo "XX n'a pas voté pour le serveur durant les XX dernières minutes";
?>
Retourne un objet avec le paramètre votes contenant le nombre de votes validés reçus pour votre serveur depuis l'adresse IP indiquée durant la periode donnée. Les valeurs envoyées via l'API sont rappelées dans la réponse, avec les paramètres ip contenant l'adresse IP recherchée et duration contenant la durée de recherche (en seconde). En cas de succès l'heure du dernier vote enregistré est également indiqué via le paramètre lastVoteDate. En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Exemple de réponse possible: {
"ip": "1.2.3.4",
"duration": 5,
"votes": 1,
"lastVoteDate": "2016-01-31 12:34:56"
}
Exemple d'utilisation (code PHP):
<?php
$is_valid_vote = file_get_contents('http://bedrock.serveurs-minecraft.org/api/is_valid_vote.php?id=XX&ip=XX&duration=XX&format=json');
$is_valid_vote = json_decode($is_valid_vote);
if (isset($is_valid_vote->votes))
echo "{$is_valid_vote->ip} a voté {$is_valid_vote->votes} fois pour le serveur durant les {$is_valid_vote->duration} dernières minutes";
else if (isset($is_valid_vote->error))
echo 'Erreur: ' . $is_valid_vote->error;
else
echo 'Erreur Inconnue';
?>
Retourne un objet avec le paramètre votes contenant le nombre de votes validés reçus pour votre serveur depuis l'adresse IP indiquée durant la periode donnée. Les valeurs envoyées via l'API sont rappelées dans la réponse, avec les paramètres ip contenant l'adresse IP recherchée et duration contenant la durée de recherche (en seconde). En cas de succès l'heure du dernier vote enregistré est également indiqué via le paramètre lastVoteDate. En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Exemple de réponse possible: {
"ip": "1.2.3.4",
"duration": 5,
"votes": 1,
"lastVoteDate": "2016-01-31 12:34:56"
}
Exemple d'utilisation (code HTML / Ajax JQuery):
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
<span id="is_valid_vote">Chargement...</span>
<script type="text/javascript">
$(window).load(function()
{
$.get(
'http://bedrock.serveurs-minecraft.org/api/is_valid_vote.php',
{ id: XX, format: 'ajax', ip: 'XX', duration: XX},
function(data)
{
if (data.votes)
$('#is_valid_vote').html(data.ip + " a voté " + data.votes + " fois pour votre serveur durant les " + data.duration + " dernières minutes");
else if (data.error)
$('#is_valid_vote').text(data.error);
});
});
</script>
La variable Javascript serveurs_minecraft_org_is_valid_vote contient un objet avec le paramètre votes contenant le nombre de vote validé reçu pour votre serveur depuis l'adresse IP indiqué durant la periode donnée. Les valeurs envoyées via l'API sont rappelées dans la réponse, avec les paramètres ip contenant l'adresse IP recherchée et duration contenant la durée de recherche (en seconde). En cas de succès l'heure du dernier vote enregistré est également indiqué via le paramètre lastVoteDate. En cas d'erreur l'objet contiendra le paramètre error qui indiquera le message d'erreur (ex: {"error": "message d'erreur"}).
Exemple de valeur possible: {
"ip": "1.2.3.4",
"duration": 5,
"votes": 1
}
contient la nombre de votes reçus par votre serveur ou un objet contenant le message d'erreur en cas d'erreur (ex: {"error": "message d'erreur"}).
Exemple d'utilisation (code HTML/Javascript):
<script type="text/javascript" src="http://bedrock.serveurs-minecraft.org/api/is_valid_vote.php?id=XX&ip=XX&duration=XX&format=jsonp"></script>
<span id="is_valid_vote"></span>
<script type="text/javascript">
window.onload = function () {
var is_valid_vote = document.getElementById("is_valid_vote");
if (serveurs_minecraft_org_is_valid_vote.votes)
is_valid_vote.innerHTML = serveurs_minecraft_org_is_valid_vote.ip + " a voté " + serveurs_minecraft_org_is_valid_vote.votes + " fois pour votre serveur durant les " + serveurs_minecraft_org_is_valid_vote.duration + " dernières minutes";
else if (serveurs_minecraft_org_votes.error)
is_valid_vote.innerHTML = 'Erreur: ' + serveurs_minecraft_org_votes.error;
else
is_valid_vote.innerHTML = '?';
}
</script>
Quota et Limitation: Afin de ne pas saturer nos serveurs vous devez vous limiter à une moyenne de 1 requête par seconde. En cas de dépassement de ce quota votre IP sera automatiquement bloqué (blacklist) pendant une durée de 24h. Ceci est une moyenne, vous pouvez, si vous le souhaitez, envoyer 50 requetes en 3 secondes a condition de ne plus en envoyer aucune pendant une minute ensuite. Attention malgré tout de ne pas abuser, si vous envoyez 300 requetes en 10 secondes vous seriez quand même blacklisté immédiatement. Pensez donc à mettre en place un système de cache pour éviter tout problème.