API

IMPORTANT: La suite de cette page s'adresse uniquement aux barbus (les developpeurs imberbes sont cependant tolérés).

Si vous souhaiter créer un site internet en relation avec ROC avec des fonctionnalités pour les joueurs. Nous vous mettons à disposition un Service Web. Vous devez d'abord nous contacter pour recevoir une clé d'accès au service(KEY_WEBSITE).
En utilisant ce service vous engagez à:
-Ne pas utiliser de scripts automatisés pour recupérer les infos des joueurs. Seul un joueur lors de la visite sur votre site doit vous permettre de récupérer les infos.
-Avoir une utilisation loyale du service: vous créer une application pour aider vos visiteurs et non pas pour voir ce qui se passe dans le camp ennemi. -Prévenir clairement le visiteur de ce que vous faites de ses données (stockez vous ou pas sa clé(KEY_USER), les données de ses personnages à chaque fois qu'il les récupère.)
-Rendre visible au visiteur toutes les données qui le concerne.
-Garder confidentielle votre KEY_WEBSITE: elle est personnelle, ne la transmettez en aucun cas à un autre webmaster ou à vos utilisateurs.

Tout manquement aux points évoqués ci-dessus entrainera un retrait de votre accès au service.

Passons maintenant aux choses sérieuses. Un gentil admin vous a donné une KEY_WEBSITE vous êtes enfin paré pour développer votre site.
Le service web permet de récupérer des informations sur un personnage. Nous y reviendrons plus en détail un peu plus loin. Il est accessible par cette URL:

http://www.raidofchaos.com/api/KEY_WEBSITE/KEY_USER/id_perso

KEY_WEBSITE => Votre clé de site web qui vous a été transmise par un admin.
KEY_USER => La clé API de l'utilisateur de votre site. Il l'a récupére à partir de sa page d'options.
id_perso => L'identifiant de son personnage(consultable également sur la page de ses options).
Aucune de ces variables n'est facultative.
Le serveur retourne un XML qui ressemble à ceci:

<infos>
    <user id="1" url_avatar="http://data2.raidofchaos.com/img/avatar/toto.png" 
     id="2" camp="humain" etat="eveille" />
    <bataille id="1" pos_x="5" pos_y="b" />
    <consommables>
        <consommable id="1" intitule="Vitamines Z23" 
        	url_image="http://data.raidofchaos.com/img/consommable/consommable_1.png"/>
        <consommable id="2" intitule="Bandage B12" 
        	url_image="http://data.raidofchaos.com/img/consommable/consommable_2.png"/>
    </consommables>
    <ressources>
        <ressource type="bois" url_image="http://data.raidofchaos.com/img/ressource/bois.png"/>
        <ressource type="fer" url_image="http://data.raidofchaos.com/img/ressource/fer.png"/>
    </ressources>
    <equipements>
        <equipement id="2" intitule="Bottes B46" 
        	url_image="http://data.raidofchaos.com/img/equipement/equipement_2.png"/>
        <equipement id="1" intitule="Bottes B37" 
        	url_image="http://data.raidofchaos.com/img/equipement/equipement_1.png"/>
    </equipements>
    <vehicules>
        <vehicule id="1" intitule="Jeep D12" 
        	url_image="http://data.raidofchaos.com/img/vehicule/vehicule_1.png"/>
        <vehicule id="2" intitule="Camion de transport C-TR" 
        	url_image="http://data.raidofchaos.com/img/vehicule/vehicule_2.png"/>
    </vehicules>
</infos>

-balise "user":
contient "id" l'ID de l'utilisateur et "url_avatar" qui est le chemin absolu vers son avatar.

-balise "personnage":
contient "id" l'ID du personnage, "camp" qui peut prendre les valeurs suivantes: humain,robot suivant le camp du personnage.
"etat" indique le statut dans lequel se trouve le personnage au moment de la requête. Valeurs possibles du champ: hors_bataille, eveille, en_combat, mort, en_recolte.

-balise "bataille":
N'apparaît que si le personnage est dans une bataille. "id" est le le numéro de la bataille dans laquelle est le personnage. "pos_x" et "pos_y" représentent l'abscisse et l'ordonnée du personnage dans la bataille.

-balises "consommables", "ressources", "equipements" et vehicules:
Apparaissent s'il y a des drops sur la case du personnage. Pour plus de détails voir l'exemple de fichier xml ci-dessus.

Si un des trois paramètres requis est incorrect, le flux XML sera de cette forme:

<errors>
    <error msg="invalid_website" />
    <error msg="invalid_user" />
    <error msg="invalid_perso" />
</errors>

"invalid_website" indique que votre KEY_WEBSITE est incorrecte ou qu'elle a été désactivé.
"invalid_user": KEY_USER incorrecte(le joueur peut l'avoir modifié) ou joueur qui n'existe pas(compte supprimé ou banni).
"invalid_perso": id_perso ne correspond pas au USER demandé.

Si vous rencontrez des difficultés lors du codage, n'hésitez pas à vous manifester sur le forum ou par MP.