Справочник API#

В следующем разделе описывается API pyspapi.

Информация о версии#

Существует два основных способа запроса информации о версии.

pyspapi.version_info#

Именованный кортеж, аналогичный py:sys.version_info.

Как и в py:sys.version_info, допустимые значения для releaselevel это „alpha“, „beta“, „candidate“ и „final“.

pyspapi.__version__#

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

pyspapi#

SPAPI#

class pyspapi.SPAPI(card_id: str, token: str, timeout: int = 5, sleep_time: float = 0.2, retries: int = 0, raise_exception: bool = False, proxy: str = None)#

pyspapi — высокоуровневый клиент для взаимодействия с SPWorlds API.

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

property balance: int | None#

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

Результат:

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

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

int

async create_payment(webhook_url: str, redirect_url: str, data: str, items: list[Item]) → str | None#

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

Параметры:

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

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

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

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

Результат:

URL для платежа или None при ошибке.

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

str

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

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

Параметры:

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

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

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

Результат:

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

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

int

async get_user(discord_id: int) → User | None#

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

Параметры:

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

Результат:

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

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

User

property me: Account | None#

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

Результат:

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

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

Account

to_dict() → dict#

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

Результат:

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

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

dict

async update_webhook(url: str) → dict | None#

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

Параметры:

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

Результат:

Ответ API в виде словаря или None при ошибке.

property webhook: str | None#

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

Результат:

URL вебхука.

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

str

webhook_verify(data: str, header: str) → bool#

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

Параметры:

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

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

Результат:

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

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

bool