wg-api-lib

WG-API-Lib

Доступно на:

EN UA RU

Описание

Этот модуль для NodeJS создан что бы упростить работу API Wargaming.net. На текущий момент библиотека поддерживает только World Of Tanks и World of Tanks Blitz

ВАЖНО! Начиная с 14-го октября 2022 года работа .ru (раньше СНГ) региона будет остановлена.
Этот пакет не поддерживает Lesta Games API (и скорей всего не будет поддерживать его никогда)

Установка

Для установки нужно написать в консоль:

npm i @muffinking-jpeg/wg-api-lib

Использование

Инициализация

Что бы начать использовать модуль нужно подключить по синтаксису ES6 (Нет поддержки для CommonJS. Давайте развиваться.) с использованием вашего ключа API.

import { wgApi } from '@muffinking-jpeg/wg-api-lib';

...

const api = new wgApi('Put your WG key here')

Хорошем тоном считается использование переменных среды или файла .env для хранения ключей ваших API

Файл .env:

...
WG_API_KEY = "YourApiKey"
...

Ваш код:

import * as dotenv from 'dotenv';
import { wgApi } from '@muffinking-jpeg/wg-api-lib';
...

dotenv.config();

const apiKey = process.env['WG_API_KEY']
const api = new wgApi(apiKey)
...

Методы

.searchPlayer(paramsObject)

Для поиска игрока мо нику.

Параметры Типы данных Значение
game: ‘wotb’ | ‘worldoftanks’ Выбор игры
region: ‘eu’ | ‘na’ | ‘asia’ Выбор региона
query: string Ник игрока

.getPlayerData(paramsObject)

Для загрузки данных игрока.

Параметры Типы данных Значение
game: ‘wotb’ | ‘worldoftanks’ Выбор игры
region: ‘eu’ | ‘na’ | ‘asia’ Выбор региона
id: number Id игрока

.getPlayerAchievements(paramsObject)

Для загрузки достижений игрока.

Параметры Типы данных Значение  
game: ‘wotb’ | ‘worldoftanks’ Выбор игры  
region: ‘eu’ | ‘na’ | ‘asia’ Выбор региона
id: number Id игрока  

Примеры

Как найти игрока по нику

api.searchPlayer({
    game: 'wotblitz',
    query: 'Holly_Carbonara',
    region: 'eu'
  }).then(res => {
    //Обработчик кода здесь
  })

Get player’s stats

api.getPlayerData({
    game: 'wotblitz',
    id: 594863503,
    region: 'eu'
  }).then(res => {
    //Обработчик кода здесь
  })

Get player’s achievements

api.getPlayerAchievements({
    game: 'wotblitz',
    id: 594863503,
    region: 'eu'
  }).then(res => {
    //Обработчик кода здесь
  })

TODO

НИКОГДА НЕ БУДЕТ РЕАЛИЗОВАНО