cointwo

COIN 2.0 API

NodeJS библиотека для работы с API сервиса "mini clicker"

Установка

npm npm i cointwo

Подключение

const { COIN } = require("cointwo");
var status_bot = true; //true/false - Работаели ли бот сейчас или на тех работах. (обязательно, только в каталоге!)
const capi = new COIN("access_token", "projectId", status_bot);

Методы API

getProjectInfo - Получить информацию о Вашем проекте

Пример:

async function run() {
  const info = await capi.getProjectInfo();
  console.log(info);
}
run().catch(console.error);

editProjectInfo - Редактировать информацию о Вашем проекте

Параметр	Тип	Обязателен	Описание
name	string	да	Название проекта
avatar	string	да	Прямая ссылка на новый аватар проекта

• Все параметры должны быть переданы

Пример:

async function run() {
  const info = await capi.editProjectInfo(
    "My app",
    "vk.com/images/camera_200.png"
  );
  console.log(info);
}

run().catch(console.error);

formatCoins - Делает получаемое из API значение коинов читабельным. Например, приходит значение 1000000,100. Этот метод сделает значение таким: 1 000 000,1

Параметр	Тип	Обязателен	Описание
coins	Number	да	Входящее значение коинов

Пример:

async function run() {
  const coins = await capi.formatCoins(1000000.1);
  console.log(coins); // (1 000 000,1)
}
run().catch(console.error);

sendPayment - Совершить перевод монет указанному пользователю

Параметр	Тип	Обязателен	Описание
toId	number	да	ID пользователя, которому Вы собираетесь совершить перевод
amount	number	да	Количество монет, которое Вы собираетесь перевести указанному пользователю

Пример:

async function run() {
  const info = await capi.sendPayment(1, 100);
  console.log(info);
}

run().catch(console.error);

Прослушивание входящих переводов:

Наша библиотека автоматически сверяет hash входящих переводов, защищая Вас от злоумышленников.

Для начала Вам стоит вызвать функцию start

Параметр	Тип	Обязателен	Описание
path	string	да	Ваш IP адрес или домен
port	number	нет	Прослушиваемый порт

Затем Вам нужно подписаться на входящие переводы, используя функцию onPayment, в параметры который нужно передать callback функцию.

Пример:

function run() {
  capi.start("http://82.112.51.71", 2096);

  capi.onPayment((context) => {
    const { amount, fromId, date, payload } = context;
    console.log(context);
  });
}

run().catch(console.error);

Пример с отправкой данных игрока:

var users = [
  {
    vkontakte_id: 1,
    coin: 1,
    ban: false, // Если игрок забанен в вашем боте, мы не будем выводить бота в каталоге
  },
];
function run() {
  capi.start("http://82.112.51.71", 2096);

  capi.onPayment((context) => {
    const { amount, fromId, date, payload } = context;
    console.log(context);
  });

  capi.getUser((context) => {
    const { fromId } = context;
    var user = vkontakte_id.find((x) => x.vkontakte_id == fromId);
    return {
      vkontakte_id: fromId,
      coin: user.coin,
      ban: user.ban
    };
    //Это нужно, что бы наш сервер мог узнать какой баланс игрока и вывести его в каталоге!
  });
}

run().catch(console.error);