Documentation technique

Exécute les challenges en local, dans n’importe quel langage (parmi ceux proposés), grâce à cette documentation.

Pour participer à un challenge, tu auras besoin de 2 éléments :
• La class Game.php
• Ta Key super secrète

Installation

Pour commencer, recopie ces quelques lignes dans un fichier dédié, par exemple index.php. Le fichier game.php et index.php doivent être dans le même dossier, sinon il faut ajuster la première ligne avec le bon chemin.

<?php
include('Game.php');

$maKey = ''; // Mets ici ta Key 
$codeChallenge = ''; // Mets ici le code challenge
$game = new Game($maKey, $codeChallenge);

$data = $game->getDatasGame(); // Pour comprendre les données proposées par le challenge
echo '<pre>';
print_r($data);
echo '</pre>';	

// ---
// Code dédié au challenge
// ---

// Pour répondre au challenge, à décommenter une fois le challenge complété
// $reponse = ['reponse' => ...];
// $game->push($reponse);

Les premières lignes permettent de paramétrer votre clé secrète ($maKey) et le code du challenge auquel vous souhaitez accéder ($codeChallenge). L'objet Game se charge alors dans la ligne suivante de contacter l'API pour lancer le challenge (méthode launch) et initialiser les données (méthode init).

Il ne vous reste plus qu'à récupérer les données grâce à la méthode getDatasGame.

Une fois votre programme établi, il vous faudra renvoyer une réponse à l'API pour contrôler votre résultat. Pour cela, il faudra utiliser la méthode push, qui doit prendre en paramètre un tableau, qui contient à minima une clé "reponse". Dans l'exemple ci-dessus, il faut compléter les "..." mais la structure du tableau doit être respectée.

Et c'est tout, libre à vous ensuite de coder votre programme comme bon vous semble. Mais n'oubliez pas qu'un code propre, c'est toujours mieux :)

Pas si vite !

Les codes des challenges sont disponibles sur la page dédiée. C'est une chaine de caractères qui reprend souvent le nom du challenge. Il faut respecter la casse.

PS : Un grand merci à Frédéric Bouchery qui a pris la peine de review la première version de la classe Game.php. Elle est beaucoup + propre maintenant :)