gok-api
Модуль для работы с API игры Game of kings
Установка библиотеки:
NPM
npm install gok-api
YARN
yarn add gok-api
Подключение
//CJS
const Gok = require('gok-api');
const gok = new Gok({
token: '16e59f56e5fc018979bb56f978a14947ca76651a03a8b8b079'
});
//ESM
import Gok from 'gok-api';
const gok = new Gok({
token: '16e59f56e5fc018979bb56f978a14947ca76651a03a8b8b079'
});| Параметр | Тип | Обязателен | Описание |
|---|---|---|---|
| token | String | Да | Ваш токен для взаимодействия с API |
Токен можно получить здесь - https://vk.com/app7711200
Методы API
getUserBalance Узнать балансы пользователей
const balances = await gok.api.getUserBalance({
users_ids: [ 590452995 ]
});
console.log(balances);
/* Пример ответа
{
[
{
id: 590452995, - айди пользователя
money: 0, - монеты
king_coin: 0 - king coins
}
]
}
*/| Параметр | Тип | Обязателен | Описание |
|---|---|---|---|
| users_ids | Array | Да | Максимум 1000 айди в массиве |
getTransactionsList
Покажет список последних переводов Вам
const payments = await gok.api.getTransactionsList({
offset: 10
});
console.log(payments);
/* Пример ответа
[{
sender_id: 590452995, - айди пользователя, который сделал Вам перевод
transfer_id: 11, - айди платежа в нашей базе данных
amount: 500, - сумма платежа
date: 1629580609299, - дата платежа в unix
currency: 'money' - валюта платежа}
}]
*/| Параметр | Тип | Обязателен | Описание |
|---|---|---|---|
| offset | Number | Нет | Количество последних переводов, если не указать, по умолчанию 50, максимум - 1000 |
sendPayment
Отправить перевод от Вашего лица
const payment_data = await gok.api.sendPayment({
to_id: 590452995,
currency: 'money',
amount: 50
});
console.log(payment_data);
/* Пример ответа
{
to_id: 590452995, - айди пользователя, которому были переведены средства
amount: 50, - сумма перевода
currency: 'money', - валюта перевода
transfer_id: 21 - айди перевода
}
*/| Параметр | Тип | Обязателен | Описание |
|---|---|---|---|
| to_id | Number | Да | Айди пользователя, которому осуществляется перевод |
| currency | String | Да | Валюта, которую необходимо перевести, money - монеты, либо king_coin - king coins соответственно |
| amount | Number | Да | Сумма перевода, за один раз максимум 1 000 000 |