1.0.1 • Published 3 years ago

soccer-coin-api v1.0.1

Weekly downloads
7
License
MIT
Repository
github
Last release
3 years ago

soccer-coin-api

npm.io

Начало работы

Для начала использования, вам нужно создать в своей папке исполняемый файл, пусть это будет index.js

Теперь его нужно открыть и импортировать библиотеку:

const { SoccerCoinAPI } = require('soccer-coin-api');

const soccercoin = new SoccerCoinAPI({
    key: 'ВАШ КЛЮЧ ДОСТУПА'
});
ПараметрТипОписание
paramsObjectПараметры
params.keyStringКлюч доступа к API
params.customServerStringПользовательский сервер API

О получении ключа доступа написано в этой статье.

Методы

call

Вызов метода API по названию. Например, в API SoccerCoin вышел новый метод, но его нет в библиотеке. Например: getProfile. Вызвать этот метод можно так:

async function getUserProfile() {
    const response = await soccercoin.api.call('getProfile', {});
    console.log(response);
}   

getUserProfile().catch(console.error);
ПараметрТипОписание
methodStringМетод
paramsObjectПараметры

getScore

Получение медалей и коинов пользователя.

async function run() {
    const response = await soccercoin.api.getScore();
    console.log(response); /* { coins: 0.001, medals: 1 } */
}   

run().catch(console.error);

Данный метод не имеет параметров.

getScoreById

Получение коинов других пользователей.

async function run() {
    const response = await soccercoin.api.getScoreById([1, 500]);
    console.log(response); /* [{ user_id: 1, coins: 0.001 }, { user_id: 500, coins: 0.001 }] */
}   

run().catch(console.error);
ПараметрТипОписание
user_idsArrayМассив с ID пользователей

sendPayment

Перевод коинов другому пользователю.

async function run() {
    const response = await soccercoin.api.sendPayment(1, 1000);
    console.log(response);
}   

run().catch(console.error);
ПараметрТипОписание
user_idNumberID пользователя
amountNumberКоличество коинов (в тысячных долях)

getHistory

Получение переводов пользователя.

async function run() {
    const response = await soccercoin.api.getHistory(100, 0);
    console.log(response);
}   

run().catch(console.error);
ПараметрТипОписание
limitNumberКоличество переводов, которое нужно получить
offsetNumberКоличество переводов, которое нужно пропустить

Полезные методы

getLastPayment

Получение последнего перевода.

async function run() {
    const response = await soccercoin.utils.getLastPayment();
    console.log(response);
}   

run().catch(console.error);

Данный метод не имеет параметров.

1.0.1

3 years ago

1.0.0

3 years ago