DofusWeb API

DofusWeb API est une petite librairie HTTP non officiel vous permettant d'intéragir avec les services web de la société Ankama.

Connexion/Déconnexion sur dofus.com
Récupération du Pseudo
Récupération de l'abonnement et de la date d'expiration
Récupération des Ogrines
Récupération des Kroz
Récupération nombre d'Ankabox
Listing des personnages (Nom, Race, Niveau et Serveur)
Connexion/Déconnexion sur account.ankama.com (Gestion de compte)
Indication SHIELD activé ou non
Indication compte certifié ou non
Obtention de l'identifiant
Obtention de l'identité (Nom, Prénom ainsi que Date de naissance)
Obtention de l'email
Obtention des numéros de téléphone
Obtention du mot de passe (caché)
Obtention de l'adresse postal principale
Conservation de la connexion (refresh possible)
Sauvegarde des cookies (fichier)

Important: Merci de respecter vos utilisateurs et de ne pas récupérer d'informations sans leur accord préalable !!!

Installation

DofusWeb API requiert au minimum PHP v5.4+ ainsi que l'extension CURL.

Github

Récupérer les sources de la librairie :

$ git clone https://github.com/Foohx/DofusWeb-API.git

Puis l'inclure dans vos scripts :

require_once '/path/to/lib/dofuswebapi.php';

Utilisation

Initialiser la class

Pour s'initialiser DofusWeb API à besoin de deux chaines de caractère. La première étant le nom de compte et la seconde étant le mot de passe.

$hDofus = new DofusWeb_API('username', 'password');

Il faut ensuite définir un fichier qui va permettre de conserver la connexion au site :

$hDofus->setCookie('/path/to/file/for/cookie.txt')

Voilà ! Vous êtes maintenant prêt pour partir à la chasse aux informations.

Collecter des informations sur Dofus.com

Connexion au compte avec les identifiants précédents :

$hDofus->reqDofusLogin();

Récupération des informations du compte :

$hDofus->collectDofusData();

Vous pouvez accéder aux informations collecté via l'attribut $dataDofus. Cet attribut est un tableau multi-dimensionnel ayant pour structure :

array(
	'account' => array(
		'nickname' 			=> 'Pseudo-Forum',
		'subscription' 		=> true/false,
		'subs_expiration' 	=> 'JJ/MM/AAAA',
		'ogrines' 			=> 1337,
		'kroz' 				=> 137,
		'ankabox' 			=> 0,
	),
	'characters' => array(
		array(
			'class'			=> 'Zobal',
			'level'			=> 10,
			'name' 			=> 'NomPerso 1',
			'server'		=> 'NomDuServeur'
		),
		array(
			'class'			=> 'Cra',
			'level'			=> 94,
			'name' 			=> 'NomPerso 2',
			'server'		=> 'NomDuServeur'
		),
		array(
			'class'			=> 'NomRace',
			'level'			=> 200,
			'name' 			=> 'NomPerso 3',
			'server'		=> 'NomDuServeur'
		)
		// etc..
	)
);

Il est désormais possible de récupérer les Kamas (montant disponible par serveur) en bourse à l'aide de la fonction :

$hDofus->collectDofusData_Bourse();

L'appel précédent doit être fait uniquement après un $hDofus->collectDofusData(); ! Ainsi l'attribut $dataDofus se verra modifier de la sorte :

array(
	'account' => array(
		'nickname' 			=> 'Pseudo-Forum',
		'subscription' 		=> true/false,
		'subs_expiration' 	=> 'JJ/MM/AAAA',
		'ogrines' 			=> 1337,
		'kroz' 				=> 137,
		'ankabox' 			=> 0,
	),
	'characters' => array(
		array(
			'class'			=> 'Zobal',
			'level'			=> 10,
			'name' 			=> 'NomPerso 1',
			'server'		=> 'NomDuServeur'
		)
		// etc..
	),
	'bourse' => array(
    	array(
        	'server' 		=> 'Helsephine'
        	'kamas' 		=> 851638
    	),
        array(
        	'server' 		=> 'Hyrkul'
        	'kamas' 		=> 0
    	)
        // etc..
    )
);

Pour les néophytes le tableau s'utilise ainsi :

echo "Ogrines : " . $hDofus->dataDofus['account']['ogrines'] . "<br />";
echo "Kroz : " . $hDofus->dataDofus['account']['kroz'] . "<br />";
// ...
echo "Perso 1 : " . $hDofus->dataDofus['characters'][0]['name'] . "<br />";
echo "Niveau : " . $hDofus->dataDofus['characters'][0]['level'] . "<br />";
echo "Perso 2 : " . $hDofus->dataDofus['characters'][1]['name'] . "<br />";
echo "Niveau : " . $hDofus->dataDofus['characters'][1]['level'] . "<br />";
// etc...

Si vous voulez lister tous les personnages ou compter combien le compte en possède :

$nombrePersonnages = count($hDofus->dataDofus['characters']);
for ($i=0; $i < $nombrePersonnages; $i++)
{
	echo "Race : " . $hDofus->dataDofus['characters'][$i]['class'] . "<br />";
	echo "Nom : " . $hDofus->dataDofus['characters'][$i]['name'] . "<br />";
	echo "Niveau : " . $hDofus->dataDofus['characters'][$i]['level'] . "<br />";
	echo "Serveur : " . $hDofus->dataDofus['characters'][$i]['server'] . "<br /><br />";
}

Une fois que vous en avez terminé avec les requêtes vous pouvez clore votre session en vous déconnectant :

$hDofus->reqAnkamaLogout();

Collecter des informations sur Ankama.com

$hDofus->reqAnkamaLogin();
$hDofus->reqAnkamaHome();
$hDofus->collectAnkamaData();
$hDofus->reqAnkamaLogout();

Structure de l'attribut $dataAccount :

array(
	'security' 		=> 0,
  	'account' => array(
     	'nickname' 	=> 'Pseudo-Forum',
     	'firstname' => 'Prénom',
     	'lastname' 	=> 'Nom',
     	'birth' 	=> 'JJ Mois AAAA',
     	'email' 	=> 'email@exemple.com',
     	'portable' 	=> '06******00',
     	'fixe' 		=> '05******00',
     	'password' 	=> '**********',
     	'address' 	=> 'ADRESSE | POSTALE | CP | VILLE',
     	'certified' => true / false
    )
);

Exemple :

echo "Bonjour Mr. " . $hDofus->dataAccount['account']['lastname'] . "<br />";
echo "Votre email de contact : " . $hDofus->dataAccount['account']['email'] . "<br />";

if ($hDofus->dataAccount['security'] == 3)
	echo "Votre compte est protégé par le SHIELD !";

Bourse aux Kamas / Ankama SHIELD

Si vous souhaitez accéder à la bourse aux Kamas et que votre compte possède le SHIELD d'activé, il est possible de passer outre !

Dans un premier temps, on essaye d'accéder normalement à la bourse. Si la fonction collectDofusData_Bourse() nous informe dans les errors qu'une protection SHIELD est présente, alors on demande un code par email :

$hDofus = new DofusWeb_API('username', 'password');

$hDofus->setCookie('cookie.txt');

$r = $hDofus->reqDofusLogin();
$hDofus->collectDofusData();
$r = $hDofus->collectDofusData_Bourse();
if ($r == False && in_array('Protected by shield !', $hDofus->errors)){
    print("SHIELD detected !\n");
    $hDofus->ShieldCode(); // Demande du code par mail pour dévérouiller le SHIELD
}

Une fois le code reçu dans votre boite, il ne faut pas vous reconnecter comme habituellement. Le fichier de cookie permet de conserver votre SESSION et donc de rester connecté. De plus aucune requête ne doit être effectuée avant la validation du code.

Dans le code suivant, on ajoute donc l'option false en second paramètres à setCookie(), ceci aura pour effet de ne pas générer une nouvelle connexion !

$hDofus = new DofusWeb_API('username', 'password');

$hDofus->setCookie('cookie.txt', false); // On souhaite conserver notre cookie précédent, d'ou le false ici !

$hDofus->ShieldValidate("V8TUST"); // V8TUST est le code reçu précédemment par mail
$hDofus->collectDofusData();
$r = $hDofus->collectDofusData_Bourse();
if ($r == False && in_array('Protected by shield !', $hDofus->errors)){
    print("SHIELD detected !\n");
    $hDofus->ShieldCode();
} else {
    print("No SHIELD detected !\n");
}

Ajouté suite à une demande de @Reptiluka

Class

Attributs

body - Contient le code source de la dernière requête effectué
code - Code HTTP de la dernière requête
dataAccount - Informations extraites du site account.ankama.com
dataDofus - Informations extraite du site dofus.com
errors - Contient une liste d'erreurs (array)

Fonctions

Toutes ces fonctions retournent true en cas de succès ou false en cas d'échec. Les fonctions débutant par req effectuent des requêtes HTTP et retourne des informations dans body et code. En cas de problèmes / d'erreurs des détails sont disponible dans l'attribut errors

askIsConnected($reload=false) - Vérifie que l'utilisateur est connecté
collectAnkamaData() - Récupère des informations et le stock dans dataAccount
collectDofusData() - Récupère des informations et le stock dans dataDofus
collectDofusData_Bourse() - Récupère des informations de la bourse aux Kamas (un appel à collectDofusData() est necéssaire avant !)
setCookie($path_to_file) - Indique dans quel fichier stocker les cookies
setLogin($username, $password) - Permet de changer les identifiants de connexion
getCookie() - Récupère le nom du fichier de cookie courant
getLogin() - Récupère les identifiants de connexion de la class
reqAnkamaHome() - Execute une requête GET sur la page d'accueil d'Ankama
reqAnkamaLogin() - Execute une requête POST afin de s'identifier sur Ankama
reqAnkamaLogout() - Execute une requête GET afin de se déconnecter d'Ankama
reqDofusHome() - Execute une requête GET sur la page d'accueil de Dofus
reqDofusLogin() - Execute une requête POST afin de s'identifier sur Dofus
reqDofusLogout() - Execute une requête GET afin de se déconnecter de Dofus
ShieldCode() - Envoi un mail contenant un code pour dévérouiller le SHIELD
ShieldValidate($code) - Valide le code reçu par mail grâce à la fonction ShieldCode()

Foohx / DofusWeb-API