Sites externes à Hordes

Hordes.fr propose aux développeurs de sites des informations sous la forme de flux XML afin de réaliser des applications complémentaires autour du jeu.

Pour cela, il leur suffit d'appeler l'URL suivante depuis leur site :

http://www.hordes.fr/xml/?k=USER_KEY

en remplaçant USER_KEY par la clé API d'un utilisateur. Cette clé est disponible en autorisant les applications externes depuis la page Réglages, dans l'âme.

Obtenir de l'aide

Vous disposez de 3 moyens pour obtenir de l'aide concernant ce flux XML :

• en vous inscrivant sur la mailing-list des développeurs Hordes. Rendez-vous sur la page suivante :

  http://groups.google.com/group/mt_hordes

• en lisant le changelog à cette adresse, pour connaître les mises à jour du flux XML : http://www.hordes.fr/xml/changelog
• en ajoutant le paramètre "comment=1" à l'URL de demande du XML. Exemple :

  http://www.hordes.fr/xml/?k=USER_KEY;comment=1

  Cela vous donnera accès à une version commentée du XML de l'utilisateur correspondant, utile pour éclaircir certains détails.

XML authentifié (ou "sécurisé")

Les informations contenues dans le XML ne sont pas nominatives par défaut. Pour obtenir les informations de l'utilisateur (login, coordonnées en jeu..etc), vous devez demander un accès au XML authentifié.

Votre demande doit être faite sur la mailing-list, en précisant l'URL normale de votre site et l'URL qui sera appelée avec les paramètres (key pour la clé utilisateur sécurisée) en POST.

Une fois votre accès validé, nous vous transmettrons par e-mail une clé unique pour votre site (appelée sk). Ne la perdez pas et ne la donnez à personne !

Votre site ne pourra être appelé que depuis l'annuaire Hordes. Vous recevrez alors une clé "key" en POST. Appelez l'URL suivante pour obtenir le XML :

http://www.hordes.fr/xml?k=USER_KEY;sk=SITE_KEY

XML de statut

Si vous souhaitez simplement connaître le statut du site Hordes.fr (ouvert, fermé, attaque en cours, maintenance...), vous pouvez accéder au flux suivant, sans clé :

http://www.hordes.fr/xml/status

XML d'âme

Vous disposez également d'un flux dédié aux informations d'âme d'un joueur donné. Il vous faut impérativement une clé sécurisée pour y avoir accès :

http://www.hordes.fr/xml/ghost?k=USER_KEY;sk=SITE_KEY

Utilisez la version commentée pour en savoir plus sur son contenu :

http://www.hordes.fr/xml/ghost?k=USER_KEY;sk=SITE_KEY;comment=1

Liens entre sites externes

Chaque paire utilisateur + site disposant d'une clé unique, il vous est impossible de rediriger un visiteur authentifié sur votre site vers un autre site externe (vous ne connaissez pas la clé correspondante).

Vous pouvez néanmoins le faire en utilisant l'URL de connexion proposée par Hordes :

http://www.hordes.fr/disclaimer?id=DESTINATION_ID

Remplacez DESTINATION_ID par le numéro ID du site vers lequel vous souhaitez rediriger l'utilisateur. Il doit être connecté sur Hordes.fr pour pouvoir utiliser cette fonctionnalité.

Évolutions futures du XML

Dans la node <headers/> du XML, vous trouverez un attribut version. Il correspond à la version du flux, sous la forme "X.yz" (exemple : 2.13).

Ce numéro se décompose comme suit :

• X : numéro de version du jeu,
• y : numéro de version majeur du XML,
• z : numéro de version mineur du XML,

Règles d'utilisation

• vous n'avez en aucun cas le droit de demander son mot de passe à un utilisateur de Hordes qui visite votre site,
• vous devez indiquer très clairement que votre site n'est en aucun cas lié officiellement à Hordes.fr,
• le design de votre site ne doit pas prêter à confusion en laissant entendre que votre site est une sous-partie de Hordes.fr : les deux mise-en-pages doivent être parfaitement distinctes,
• vous n'avez pas le droit d'utiliser des scripts automatisés pour récupérer régulièrement les données d'un XML (cron, tâches automatisées...),
• si vous utilisez des images ou contenus de Hordes, vous devez indiquer leur provenance et les droits d'auteur qui s'appliquent.