README.md

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 une clé API. Vous pouvez en obtenir une en créant un compte sur le readme de NationsGlory.

Installation

npm install nationsapi

Utilisation

const NationsAPI = require('nationsapi');
const ngApi = new NationsAPI('API_KEY');

// Récupérer le nombre de joueurs actuel
ngApi.server.getPlayersCount().then((data) => {
    console.log(data);
}).catch((error) => {
    console.error(error);
});

// Récupérer des informations sur un joueur 
ngApi.user.get('baba_33_mrt').then((data) => {
    console.log(data);
}).catch((error) => {
    console.error(error);
});

// Il est fortement recommandé de stocker les
// clés d'API dans un fichier .env

Méthodes

Meri de regarder la page Wiki pour plus d'informations sur les méthodes disponibles.

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