Webmaster API Jocly

Webmaster API Jocly

 

L'API webmaster permet d'utiliser les services de Jocly depuis un autre site. Le server Jocly fournit un certain nombre d'URLs dans ce but.

Les requêtes nécessitent un ID webmaster à inclure dans l'URL d'API. L'ID webmaster peut être obtenu depuis le compte utilisateur sur le site Jocly.

Jouer à un jeu

L'intégration du jeu est fait par via une iframe dont l'attribute "src" est mis à:

http://www.jocly.com/jocly/wapi/{webmaster id}/play-game/{game name}

{game name} est le nom machine du jeu à lancer (voir http://www.jocly.com/jocly/wapi/show-games pour la liste des jeux disponibles.

Certains paramètres peuvent être ajoutés à l'URL afin de controler le comprtement:

level: le niveau par défaut. la valeur doit être prise depuis le retour de la méthode get-game (voir plus loin).

start: une valeur parmi:

dont-mind: le premier joueur est choisi aléatoirement

i-start: l'utilisateur commence à jouer

other-starts: l'ordinateur commence à jouer

autostart: par défaut, l'iframe affiche un écran où l'utilisateur peut choisir le niveau et les options de démarrage avant que le jeu lui-même ne commence. Si autostart est mis à true, le jeu commence immédiatement.

Par exemple, le code HTML suivant affiche un jeu de dames, taille 400 par 400, l'utilisateur démarrant immédiatement au premier niveau:

<iframe src="http://www.jocly.com/jocly/wapi/{webmaster id}/play-game/draughts?autostart=true&level=0&start=i-start" width="400" height="400" frameborder="0"></iframe>

Lister les jeux disponibles

Les informations sur les jeux disponibles peuvent être obtenues depuis une représentation JSON d'un tableau contenant pour chaque jeu, les noms machine et humain, l'URL de l'image de vignette et le lien pour l'iframe.

http://www.jocly.com/jocly/wapi/{webmaster id}/list-games

Détail d'un jeu

L'information sur les niveaux disponibles pour un jeu spécifique:

http://www.jocly.com/jocly/wapi/{webmaster id}/get-game/{game name}

Lister les langues disponibles

Retourne la liste des langages disponible (pour l'instant 'en' et 'fr') en tant que tableau JSON.

http://www.jocly.com/jocly/wapi/{webmaster id}/get-langs

Forcer la langue

Normalement, Jocly prend en compte la langue du navigateur et affiche le jeu en fonction. Cependant, il est possible de forcer le langage pour correspondre avec une préférence utilisateur éventuelle. Le choix de la langue affecte l'interface utilisateur du jeu, mais il n'est pas garanti que le jeu lui-même gère la langue choisie (par exemple, les règles peuvent n'être disponibles qu'en anglais).

http://www.jocly.com/jocly/wapi/{webmaster id}/set-lang/{language}

Il est possible d'enlever une langue qui a été préalablement forcée. L'interface utilisateur sera alors affichée en utilisant la détection automatique.

http://www.jocly.com/jocly/wapi/{webmaster id}/unset-lang