API Reference#

The following section outlines the API of pyspapi.

Version Info#

There are two main ways to query version information.

pyspapi.version_info#

A named tuple that is similar to py:sys.version_info.

Just like py:sys.version_info the valid values for releaselevel are „alpha“, „beta“, „candidate“ and „final“.

pyspapi.__version__#

A string representation of the version.

pyspapi#

SPAPI#

class pyspapi.SPAPI(card_id=None, token=None, timeout=5, sleep_time=0.2, retries=0)#

Представляет собой клиент API для взаимодействия с конкретным сервисом.

property balance#

Получает текущий баланс карты.

Результат:

Текущий баланс карты.

Тип результата:

int

property webhook: str#

Получает URL вебхука, связанного с картой.

Результат:

URL вебхука.

Тип результата:

str

property me#

Получает информацию об аккаунте текущего пользователя.

Результат:

Объект Account, представляющий аккаунт текущего пользователя.

Тип результата:

Account

async get_user(discord_id: int) → User#

Получает информацию о пользователе по его ID в Discord.

Параметры:

discord_id (int) – ID пользователя в Discord.

Результат:

Объект User, представляющий пользователя.

Тип результата:

User

async create_transaction(receiver: str, amount: int, comment: str)#

Создает транзакцию.

Параметры:

  • receiver (str) – Получатель транзакции.

  • amount (int) – Сумма транзакции.

  • comment (str) – Комментарий к транзакции.

Результат:

Баланс после транзакции.

Тип результата:

int

async create_payment(webhook_url: str, redirect_url: str, data: str, items) → str#

Создает платеж.

Параметры:

  • webhook_url (str) – URL вебхука для платежа.

  • redirect_url (str) – URL для перенаправления после платежа.

  • data (str) – Дополнительные данные для платежа.

  • items – Элементы, включаемые в платеж.

Результат:

URL для платежа.

Тип результата:

str

async update_webhook(url: str)#

Обновляет URL вебхука, связанного с картой.

Параметры:

url (str) – Новый URL вебхука.

Результат:

JSON-ответ от API.

Тип результата:

dict

webhook_verify(data: str, header) → bool#

Проверяет достоверность вебхука.

Параметры:

  • data (str) – Данные из вебхука.

  • header – Заголовок X-Body-Hash из вебхука.

Результат:

True, если заголовок из вебхука достоверен, иначе False.

Тип результата:

bool

to_dict() → dict#

Преобразует объект SPAPI в словарь.

Результат:

Словарное представление объекта SPAPI.

Тип результата:

dict