nationsapi v1.0.1

NationsAPI

Une interface de programmation simple pour accéder à l'API publique de NationsGlory.

Table des matières

• Préréquis
• Installation
• Méthodes
• Gestion des erreurs
• Contribution
• Retours
• Licence

Préréquis

• Disposer d'un jeton API valide. Vous pouvez en obtenir un en contactant NationsGlory à l'adresse suivante gestion@nationsglory.fr.
  • Petit conseil : essayez de décrire votre projet et ne demandez pas un jeton simplement pour en avoir un.

Installation

npm install nationsapi

Utilisation javascript

const NationsAPI = require('your-npm-package-name');
const api = new NationsAPI('YOUR_API_TOKEN');

// Obtenir le nombre de joueurs
api.getPlayersCount().then(data => console.log(data));

// Obtenir des notations
api.getNotations(week, country, server).then(data => console.log(data));

// ... (et ainsi de suite pour les autres méthodes)
// Remarque : n'oubliez pas de remplacer 'YOUR_API_TOKEN' par votre véritable jeton API.

Méthodes

• getPlayersCount() Renvoie le nombre actuel de joueurs.

• getNotations(week?, country?, server) Obtient les notations pour une semaine donnée, un pays et un serveur. Si aucun paramètre n'est fourni, la semaine par défaut est calculée en fonction de la date actuelle.

• getPlanning(server, month, year) Obtient les informations de planification pour un serveur, un mois et une année spécifiques.

• getUser(username) Récupère les informations sur un utilisateur spécifique.

• getCountry(server, country) Récupère les informations sur un pays spécifique pour un serveur donné.

Gestion des erreurs

Toutes les méthodes renvoient une promesse. En cas d'échec de la requête, un objet d'erreur est renvoyé avec un champ error.

Contribution

Si vous souhaitez contribuer à ce projet, veuillez suivre ces étapes : 1. Forkez le dépôt. 2. Créez une nouvelle branche pour vos modifications. 3. Soumettez une pull request.

Retours

N'hésitez pas à ouvrir une issue sur GitHub si vous avez des retours ou des suggestions. Vos commentaires sont toujours les bienvenus!

Licence

Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus de détails.

Conçu avec ❤️ par baba33mrt