API Anathas

Anathas propose une API basique en lecture seulement qui peut être utilisée pour la création de bots ou d'outils d'intégration pour la communauté.

Pour utiliser l'API vous devez d'abord demander un 'token' qui identifiera votre projet. Seuls les projets concrets et bénéficiant à la communauté seront acceptés.

La documentation de l'API est disponible ci-dessous.

Obsolète voir ci-dessous pour la v2

Bases de l'API v1

Une API HTTP, retournant une réponse en JSON.

Les requêtes, GET uniquement, sont faites à l'adresse :

https://www.anathas.com/ajax/api.php

Paramètres nécessaires

• v=1 (la version de l'API, seule 1 est supporté pour le moment)
• token=abcdefg (le token unique, fourni lorsque vous aurez été autorisé à utiliser l'API)
• request= ... (définit le type de requête API)
• Des paramètres additionnels sont nécessaires selon le type de requête.

Les types de requêtes supportés sont :

• game-data
• player-data
• read-shoutbox

Le fonctionnement de chaque requêtes est détaillé ensuite.

Réponse

La réponse est un objet JSON avec 2 champs.

• success = true/false indique si la requête a été exécutée avec succès
• error, si success est false, contient un message d'erreur
• data, si success est true, contient le contenu de la réponse

Exemple de requête :

https://www.anathas.com/ajax/api.php?v=1&token=<xxx>&request=player-data&ID=3606

Réponse :

{"success":true,"data":{"techa":"150","techi":"80","techc":"76","rank":37,"prech":"260","cycles":62}}

Exemple de requête :

https://www.anathas.com/ajax/api.php?v=1&token=<xxx>&request=player-data&ID=99999

Réponse :

{"success":false,"error":"ce joueur n'existe pas"}

API v1 (obsolète)

game-data

Retourne des informations générales sur la partie en cours (pour le moment, le cycle en cours).

Aucun paramètre n'est accepté.

player-data

Retourne des informations sur un joueur en particulier.

Le paramètre ID (l'identifiant du joueur) est nécessaire.

La réponse contient les champs :

• techa : le niveau de technologie agricole
• techi : le niveau de technologie industrielle
• techc : le niveau de technologie commerciale
• ptech : le nombre de points de recherche
• rank : la position dans le classement (tel qu'affichée sur le profil du joueur)
• cycles : le nombre de cycles d'ancienneté du joueur

read-shoutbox

Permet de lire la shoutbox.

Paramètres :

• box : détermine quelle boite lire (seules les boites 0 1 et 2 sont supportées), optionel et 0 par défaut
• fromID : détermine le message le plus ancien qui doit être retourné, non inclusif. Par exemple si fromID = 100, seuls les messages avec un ID de 101 ou plus seront retournés. Permet donc d'éviter les doublons lorsque plusieurs requêtes à l'API sont faites à la suite.

Réponse :

{

untilID : l'identifiant du message le plus récent retourné (à utiliser comme paramètre fromID de la prochaine requête).

messages : un tableau de messages

}

Chaque message est un objet :

{

ID : l'identifiant du message

joueur : le pseudo du joueur ayant envoyé le message

message : le message

date : le timestamp UNIX représentant le moment où le message a été posté, fuseau horaire Europe/Paris

}

API v2

L'api passe en version 2. Il s'agit cette fois d'une API REST + HAL.

Comme auparavant, pour l'utiliser vous aurez besoin d'une clé API. Pour obtenir une clé API, vous devez présenter votre projet publiquement sur le forum. Le projet doit être accessible et bénéficier à tous les joueurs.

Le token doit être envoyé de préférence en utilisant le header X-API-Key. Les requêtes faites à l'API doivent être server-to-serveur (sans quoi votre token serait compromis.

La racine de l'API est accessible à

 https://www.anathas.com/api/v2

Elle supporte la partie courante à

 https://www.anathas.com/api/v2/games/current

Liste des pays (classement)

 https://www.anathas.com/api/v2/games/current/countries

Détails d'un pays

 https://www.anathas.com/api/v2/games/current/countries/9690

Liste des alliances

 https://www.anathas.com/api/v2/games/current/alliances

Détails d'une alliance

 https://www.anathas.com/api/v2/games/current/alliances/717

Statistiques des cycles

https://www.anathas.com/api/v2/games/current/stats/latest

Dans les informations JSON de x pays, le lvl agricole est nommé "tech_military"

ouaip remonté dans mes feedbacks également