@ix-xs/metamob.api
v1.0.6
Published
Metamob API JS
Downloads
5
Readme
npm install @ix-xs/metamob.api
const MetamobAPI = require("@ix-xs/metamob.api");
const client = new MetamobAPI({ apiKey:"votre_clé_api" });
Méthode | options | Description |
| --- | --- | --- |
| getUser()
| username
:string; | Récupère les informations d'un utilisateur. Non sensible à la casse. |
| getUserMonsters()
| username
:string;{type?
:string;monstre?
:string;etape?
:string;quantite?
:string;etat?
:string;} | Récupère les monstres d'un utilisateur. Le nom d'utilisateur n'est pas sensible à la casse. |
| getMonsters()
| {monstre?
:string;etape?
:string;type?
:string;} | Récupère les monstres. |
| getServers()
| server?
:string; | Récupère les serveurs. |
| getKralamoures()
| {serveur?
:string;date_debut?
:string;date_fin?
:string;} | Récupère les kralamoures. |
| getZones()
| zone?
:string; | Récupère les zones. |
| getSouszones()
| souszone?
:string; | Récupère les sous-zones. |
| putUserMonsters()
| username
:stringuniqueId
:stringbody
:Array<{monstre
:string;quantite?
:string;etat?
:string;}> | Met à jour les informations de monstre d'un compte utilisateur.Le champ quantite indique l'opération à effectuer sur la quantité:• Si la quantité renseigner commence par "===", la quantité du monstre sera forcée à cette valeur.• Si la quantité renseigner commence par "+", la quantité du monstre sera incrémenter de cette valeur• Si la quantité renseigner commence par "-", la quantité du monstre sera décrémenter de cette valeur |
| resetUserMonsters()
| username
:string;uniqueId
:string; | Réinitialise les monstres sur le compte. Cela signifie que toutes les informations relatives aux monstres seront supprimées !Les monstres seront mis à l'état aucun (ni recherché ni proposé), avec une quantité nulle (0). |
const MetamobAPI = require("@ix-xs/metamob.api");
const client = new MetamobAPI({ apiKey:"votre_clé_api" });
// Renvoie les informations de l'utilisateur
client.getUser("popop").then(console.log);
// Renvoie les monstres "proposés" dont l'utilisateur possède en + de 1 exemplaire
client.getUserMonsters("popop", { etat:"propose", quantite:">1" }).then(console.log);
// Renvoie les monstres de l'utilisateur à l'étape 20
client.getUserMonsters("popop", { etape:"20" }).then(console.log);
// Renvoie la liste de tous les monstres
client.getMonsters().then(console.log);
// Renvoie la liste de tous les archimonstres
client.getMonsters({ type:"archimonstre" }).then(console.log);
// Renvoie la liste de tous les serveurs
client.getServers().then(console.log);
// Renvoie les informations sur le serveur "Tylezia"
client.getServers("Tylezia").then(console.log);
// Renvoie la liste des ouvertures prévues entre la date du jour et 1 mois plus tard
client.getKralamoures().then(console.log);
// Renvoie la liste des ouvertures prévues entre la date du jour et le 01 juin 2024 sur le serveur Tylezia
client.getKralamoures({ serveur:"Tylezia", date_fin:"2023-06-01" }).then(console.log);
// Renvoie la liste de toutes les zones
client.getZones().then(console.log);
// Renvoie les informations sur la zone Amakna
client.getZones("Amakna").then(console.log);
// Renvoie la liste de toutes les sous-zones.
client.getSouszones().then(console.log);
// Renvoie les informations sur la sous-zones Aerdala
client.getSouszones("Aerdala").then(console.log);
// La quantité du monstre Arakne sera incrémenter de 5 et passera à l'état proposé
// La quantité du monstre Larchimaide la Poussée passera à 3
// La quantité du monstre Bouftou Royal sera décrémenter de 2
client.putUserMonsters("nom_utilisateur", "id_unique_utilisateur", [
{ monstre:"Arakne", quantite:"+5", etat:"propose" },
{ monstre:"Larchimaide la Poussée", quantite:"===3" },
{ monstre:"Bouftou Royal", quantite:"-2" },
]).then(console.log);
// Tous les monstres de l'utilisateur seront réinitialiser (quantite à 0 et aucun état)
client.resestUserMonsters("pseudo_utilisateur", "id_unique_utilisateur").then(console.log);