node-cosmo-game-sdk
v1.0.1
Published
API Cosmo Game для разработки ботов, приложений, сайтов.
Downloads
2
Maintainers
Readme
node-cosmo-game-sdk
API Cosmo Game для разработки ботов, приложений, сайтов.
Установка
Windows:
- Скачайте и установите, желательно, последнюю версию Node.JS
- Создайте в удобном месте папку, например cosmo_market
- Перейдите в командную строку из этой папки: напишите cmd за место пути до папки
- В появившейся консоли пропишите: npm i --save node-cosmo-game-sdk
Ubuntu:
- Установите Node.JS по этому гайду
- Создайте в удобном месте папку, например cosmo_market
- Перейдите в папку: cd (путь до вашей папки)
- Пропишите: npm i --save node-cosmo-game-sdk
Начало работы
Для начала использования, вам нужно создать в своей папке исполняемый файл, пусть это будет index.js
Теперь его нужно открыть и импортировать библиотеку:
const COSMOAPI = require('node-cosmo-game-sdk');
const cosmo = new COSMOAPI(options);
|Опция|Тип|Описание| |-|-|-| |options|Object|Опции конструктора| |options.key|String|Ключ для взаимодействия с API| |options.userId|Number|Ваш айди ВК|
Где взять эти значения
- Получение ключа (key): в настройках бота есть команда Получить API ключ
- Получение айди вк (userId):
Откройте свою аватарку и в адресной строке вы увидите подобное: https://vk.com/id1?z=photo1_456264771%2Falbum1_0%2Frev
Вашим айди будет являться число после слова photo. В этом случае 1
API
getTransfers - Получает список переводов
const test = async () => {
const result = await cosmo.methods.getTransfers(type, offset, limit, cb);
console.log(result);
}
test();
|Параметр|Тип|Описание| |-|-|-| |type|String|Тип необходимых переводов, доступно: all - любые, in - пополнения, out - переводы| |offset|Number|Смещение, необходимое для выборки определённого подмножества переводов| |limit|Number|Количество переводов которое нужно получить, максимальное значение 100| |cb|Function|Функция CallBack при ошибке|
createTransfer - Делает перевод другому пользователю (сумма в десятичных долях)
const test = () => {
const result = await cosmo.methods.createTransfer(toId, amount, cb); // 1 коин = 1_000 ед.
console.log(result);
}
test();
|Параметр|Тип|Описание| |-|-|-| |toId|Number|Айди получателя| |amount|Number|Сумма перевода| |cb|Function|Функция CallBack при ошибке|
getMyBalance - Получает баланс текущего пользователя
const test = async() => {
const myBalance = await cosmo.methods.getMyBalance(cb);
console.log(myBalance);
}
test();
|Параметр|Тип|Описание| |-|-|-| |cb|Function|Функция CallBack при ошибке|