vkcoin 1.7

Враппер для платёжного API VK Coin

vkcoin

Враппер для платёжного API VK Coin. https://vk.com/@hs-marchant-api

Установка

• Скачайте и установите Python версии 3.6 и выше
• Введите следующую команду в командную строку:

pip install vkcoin  

• Или, вы можете собрать библиотеку с GitHub:

pip install git+git://github.com/crinny/vkcoin.git  

• Вы прекрасны!

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

Для начала разработки, необходимо создать в своей папке исполняемый файл с расширением .py, например test.py. Вы не можете назвать файл vkcoin.py, так как это приведёт к конфликту. Теперь файл нужно открыть и импортировать библиотеку:

import vkcoin  

Данная библиотека содержит в себе 2 класса:

• VKCoinApi - для работы с API VKCoin-а
• VKCoinWS - для получения CallBack сообщения об зачислении коинов

VKCoinApi

merchant = vkcoin.VKCoinApi(user_id=123456789, key='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')  

Параметр	Тип	Описание
user_id	Integer	ID аккаунта ВКонтакте
key	String	Ключ для взаимодействия с API

Методы

Необязательные параметры при вызове функций выделены курсивом.

get_payment_url - получет ссылку на оплату VK Coin

result = merchant.get_payment_url(amount=10, payload=78922, free_amount=False)  
print(result)  

Параметр	Тип	Описание
amount	Float	Количество VK Coin для перевода
payload	Integer	Число от -2000000000 до 2000000000, вернется в списке транзаций
free_amount	Boolean	True, что бы позволить пользователю изменять сумму перевода

get_transactions - получает список ваших транзакций

result = merchant.get_transactions(tx=[2])  
print(result)  

Параметр	Тип	Описание
tx	List	Массив ID переводов для получения или [1] - последние 1000 транзакций, [2] - 100
last_tx	Integer	Если указать номер последней транзакции, то будут возвращены только транзакции после указанной

send_coins - делает перевод другому пользователю

result = merchant.send_coins(amount, to_id) print(result)  

Параметр	Тип	Описание
amount	Float	Сумма перевода
to_id	Integer	ID аккаунта, на который будет совершён перевод

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

result = merchant.get_user_balance(123456789, 987654321)  
print(result)  

Тип	Описание
Integer	ID аккаунтов через запятую, баланс которых нужно получить

get_my_balance - возвращает ваш баланс

result = merchant.get_my_balance()  
print(result)  

VKCoinWS (CallBack)

VKCoin для взаимодействия между клиентом и сервером использует протокол WebSocket.
Данный класс реализован для получения обратных вызовов при входящих транзакциях на аккаунт, доступ к которому может быть предоставлен одним из следующих параметров при создании объекта класса:

callback = vkcoin.VKCoinWS(token, iframe_link)  

Параметр	Тип	Описание
token	String	acces_token вашего аккаунта *
iframe_link	String	ссылка на iframe сервиса VKCoin **

* получение токена - перейдите по ссылке, нажмите "Разрешить" и скопируйте часть адресной строки после access_token= и до &expires_in (85 символов)

** эту ссылку можно достать в коде страницы vk.com/coin

1. Переходим на vk.com/coin
2. Используем сочетание клавиш ctrl + U для просмотра исходного кода страницы
3. Открываем поиск, вводим sign=
4. Копируем найденную ссылку, содержащую параметр sign

После инициализации объекта необходимо зарегистрировать функцию, которая будет обрабатывать входящие платежи. Для этого используется декоратор handler

@callback.handler  
def your_func(data):  
 do_something...```  
При получении обратного вызова - входящей транзакции - в зарегестрированную функцию возвращается объект класса `Entity`, который является абстракцией входящего перевода и содержит следующие параметры:  
```python  
data.user_id - # ваш ID  
data.balance - # баланс вашего аккаунта data.user_from - # ID отправителя (инициатор входящей транзакции)  
data.amount - # количество полученных коинов  

Теперь можно запустить веб-сокет:

callback.run_ws()

Данный метод запускает веб-сокет в новом потоке и остается в главном потоке, поэтому вызов метода не является блокирующим

Примеры

Callback

import vkcoin  

callback = vkcoin.VKCoinApi(token='xxxxxxxxxxxxxxxxxxxxxxxxxxxxx') # либо ссылка на iframe  

@callback.handler  
def with_transfer(data):  
 user_id = data.user_id my_balance = data.balance sender = data.user_from amount = data.amount  callback.run_ws()  # запускаем веб-сокет - все входящие платежи   
      # будут возвращаться в функцию with_transfer  

Где меня можно найти

Могу ответить на ваши вопросы

• ВКонтакте
• Telegram
• Чат ВКонтакте по VK Coin API