Skip to main content

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

Project description

vkcoin

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

Установка

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

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

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

import vkcoin

merchant = vkcoin.Merchant(user_id=123456789, key='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
Параметр Тип Описание
user_id Integer ID аккаунта ВКонтакте
key String Ключ для взаимодействия с API
token String Токен VK API, полученный по инструкции (необходим только для on_payment)
on_payment Function Callback функция, которая будет вызвана при получении перевода от других пользователей

Методы

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

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=[1])
print(result)
Параметр Тип Описание
tx List Массив ID переводов для получения или [1] - последние 1000 транзакций, [2] - 100
last_tx Integer Если указать номер последней транзакции то будут возвращены только транзакции после указанной

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

result = merchant.send(amount=100, to_id=371576679)  # Если запустить этот код, вы переведёте мне 100 VK Coin :)
print(result)
Параметр Тип Описание
amount Float Сумма перевода
to_id Integer ID аккаунта, на который будет совершён перевод

get_balance - возвращает баланс аккаунта

result = merchant.get_balance(user_ids=123456789)
print(result)
Параметр Тип Описание
user_ids List ID аккаунтов, баланс которых нужно получить

Callback

Описание параметров, которые будут переданы в callback функции.

on_payment - вызывается при получении перевода от других пользователей

def on_payment_recieved(user_id, amount):
    print(user_id, amount)
Параметр Тип Описание
user_id Integer ID аккаунта, с которого был совершён перевод
amount Float Сумма перевода

Примеры

Callback

import vkcoin

def on_payment_recieved(user_id, amount):
    print(user_id, amount)

merchant = vkcoin.Merchant(user_id=123456789, key='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', on_payment=on_payment_recieved)

Благодарности

Эдгар Горобчук - за написание SpootiFM/vkcoin

Eвгений Чертков - за PEP

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

vkcoin-1.5.5-py3-none-any.whl (5.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page