1.0.11 • Published 1 year ago

cosmo-api v1.0.11

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

cosmo-api

API Cosmo App для разработки ботов, приложений, сайтов.

npm package

Установка

Windows:

  • Скачайте и установите, желательно, последнюю версию Node.JS
  • Создайте в удобном месте папку, например cosmo_market
  • Перейдите в командную строку из этой папки: напишите cmd за место пути до папки
  • В появившейся консоли пропишите: npm i --save cosmo-api

Ubuntu:

  • Установите Node.JS по этому гайду
  • Создайте в удобном месте папку, например cosmo_market
  • Перейдите в папку: cd (путь до вашей папки)
  • Пропишите: npm i --save cosmo-api

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

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

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

const { COSMOAPI } = require('cosmo-api');
const cosmo = new COSMOAPI(options);
ОпцияТипОписание
optionsObjectОпции конструктора
options.keyStringКлюч для взаимодействия с API

Где взять эти значения

  • Получение ключа (key): в настройках бота есть команда Получить API ключ

API

getTransfers - Получение переводов

const test = async () => {
    const result = await cosmo.methods.getTransfers(type, offset, limit);
    console.log(result);
}
test();
ПараметрТипОписание
typeStringТип необходимых переводов, доступно: all - все, in - пополнения, out - выводы
offsetNumberСмещение, необходимое для выборки определённого подмножества переводов
limitNumberКоличество переводов которое нужно получить, максимальное значение 100

createTransfer - Перевод пользователю или в магазин

const test = () => {
    const result = await cosmo.methods.createTransfer(toId, amount); // 1 коин = 1.00 ед.
    console.log(result);
}
test();
ПараметрТипОписание
toIdNumberАйди получателя
amountNumberСумма перевода

getMyBalance - Получение баланса текущего пользователя или магазина

const test = async() => {
    const myBalance = await cosmo.methods.getMyBalance();
    console.log(myBalance);
}
test();

getBalance - Получение балансов пользователей и магазинов

const test = async() => {
    const balances = await cosmo.methods.getBalance(ids);
    console.log(balances);
}
test();
ПараметрТипОписание
idsNumber[]Айди получателей

Ссылки