1.0.11 • Published 1 year ago
cosmo-api v1.0.11
cosmo-api
API Cosmo App для разработки ботов, приложений, сайтов.
Установка
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);
Опция | Тип | Описание |
---|---|---|
options | Object | Опции конструктора |
options.key | String | Ключ для взаимодействия с API |
Где взять эти значения
- Получение ключа (key): в настройках бота есть команда Получить API ключ
API
getTransfers - Получение переводов
const test = async () => {
const result = await cosmo.methods.getTransfers(type, offset, limit);
console.log(result);
}
test();
Параметр | Тип | Описание |
---|---|---|
type | String | Тип необходимых переводов, доступно: all - все, in - пополнения, out - выводы |
offset | Number | Смещение, необходимое для выборки определённого подмножества переводов |
limit | Number | Количество переводов которое нужно получить, максимальное значение 100 |
createTransfer - Перевод пользователю или в магазин
const test = () => {
const result = await cosmo.methods.createTransfer(toId, amount); // 1 коин = 1.00 ед.
console.log(result);
}
test();
Параметр | Тип | Описание |
---|---|---|
toId | Number | Айди получателя |
amount | Number | Сумма перевода |
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();
Параметр | Тип | Описание |
---|---|---|
ids | Number[] | Айди получателей |