vcoin-api

vcoin-api

JavaScript библиотека для работы с Vk Coin.
Документация к Vk Coin Api: https://vk.com/@hs-marchant-api

Возможности:

• Перевод коинов другому пользователю
• Создание ссылки для перевода платежа
• Получение баланса пользователей
• Получение списка переводов

Установка

1. Создайте рабочую директорию
2. Откройте консоль в этой директории и выполните команду

   npm i vcoin-api --save-dev

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

Подключение и создание экземпляра

Создайте файл в корне рабочей директории (например index.js) и напишите следующий код:

const package = main;

const VkCoinApi = require('vcoin-api'); // подключаем библиотеку

async function main() {
	
	//создаем новый экземпляр класса
	let vcoin = new VkCoinApi({
		key: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', //ключ для работы с Vk Coin API (как получить: https://vk.com/@hs-marchant-api)
		userId: 12345678, // id вашей страницы во Вконтакте 
	});
}

package();

Значение	Тип	Описание
key	String (Строка)	Ключ для работы с Vk Coin API
userId	Number (Число)	id вашей страницы во Вконтакте

Методы

sendPayment

Позволяет перевести коины другому пользователю

const package = main;

const VkCoinApi = require('vcoin-api');

async function main() {
	
	let vcoin = new VkCoinApi({
		key: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
		userId: 12345678, 
	});

	let response = await vcoin.sendPayment(1, 10); //переводит 10 коинов пользователю с id 1

	console.log(response);
	/*
	# 	output:
	# 	{ response: { id: 1353458, amount: 1000, current: 167357801 } }
	*/

}

package();

Значение	Тип	Описание
userId	Number	id получателя
amount	Number	количество коинов для перевода

getPaymentLink

Создает ссылку по которой осуществляется перевод коинов на ваш аккаунт

const package = main;

const VkCoinApi = require('vcoin-api');

async function main() {
	
	let vcoin = new VkCoinApi({
		key: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
		userId: 12345678,
	});

	let response = vcoin.getPaymentLink(200, true); //создает фиксированную ссылку для перевода 200 коинов на ваш аккаунт

	console.log(response);
	/*
	# 	output:
	# 	vk.com/coin#x312934096_200000_742198928
	*/

}

package();

Значение	Тип	Описание
amount	Number	количество коинов для перевода
fixed	Boolean	Фиксированная ссылка(пользователь не сможет менять кол-во коинов для перевода). По умолчанию true

getBalance

Возвращает баланс аккаунта(ов)

const package = main;

const VkCoinApi = require('vcoin-api');

async function main() {
	
	let vcoin = new VkCoinApi({
		key: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
		userId: 12345678,
	});

	let response = vcoin.getBalance(); //вернет ваш баланс
	console.log(response);
	/*
	# 	output:
	# 	{ response: { '312934096': 167357801 } }
	*/

	let response = vcoin.getBalance(1); //вернет баланс пользователя с id 1

	let response = vcoin.getBalance([1, 344, 438923]); //вернет баланс нескольких пользователей с id 1, 344, 438923

}

package();

Значение	Тип	Описание
id	Number/Array/<>	id либо массив из id нескольких пользователей(макс. 100 значений). Без передачи аргумента возвращает баланс вашего аккаунта.

getTransactionList

Возвращает список транзакций

const package = main;

const VkCoinApi = require('vcoin-api');

async function main() {
	
	//создаем новый экземпляр класса
	let vcoin = new VkCoinApi({
		key: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', //ключ для работы с Vk Coin API (как получить: https://vk.com/@hs-marchant-api)
		userId: 12345678, // id вашей страницы во Вконтакте 
	});

	let response = vcoin.getTransactionList(1); //список транзакций осуществленных по ссылке (например vk.com/coin#x312934096_200000_742198928)
	let response = vcoin.getTransactionList(2); //список транзакций с аккаунта на аккаунт

}

package();

Значение	Тип	Описание
tx	Number	принимает значения 1 или 2