From 152b5272c1a82600325629fdade7ce977f4eeb60 Mon Sep 17 00:00:00 2001 From: Aleksey Date: Mon, 18 Jul 2022 03:15:38 +0300 Subject: [PATCH] Update README.rst --- README.rst | 91 +++++------------------------------------------------- 1 file changed, 7 insertions(+), 84 deletions(-) diff --git a/README.rst b/README.rst index 7defe57..677b5d4 100644 --- a/README.rst +++ b/README.rst @@ -40,101 +40,24 @@ pyspapi sudo apt pip3 install pyspapi -Примеры ------ +Быстрый пример +========= -`Оплата `_ +Проверка баланса ~~~~ .. code:: python - from spapi import Api - - api = Api(card_id='CARD_ID', - token='TOKEN') - - print(api.payment(amount=1, - redirecturl='https://www.google.com/', - webhookurl='https://www.yourwebhook.com/', - data='some-data' - ) - ) - -* ``amount`` - Стоимость покупки в АРах -* ``redirectUrl`` - URL страницы, на которую попадет пользователь после оплаты -* ``webhookUrl`` - URL, куда наш сервер направит запрос, чтобы оповестить ваш сервер об успешной оплате -* ``data`` - Строка до 100 символов, сюда можно поместить любые полезные данных. - -`Получение данных об успешной оплате `_ -~~~~ - -После успешной оплаты на URL указанный в ``webhookUrl`` придет POST запрос. - -*Тело запроса будет в формате JSON:* - -* ``payer`` - Ник игрока, который совершил оплату -* ``amount`` - Стоимость покупки -* ``data`` - Данные, которые вы отдали при создании запроса на оплату - -**Для проверки достоверности webhook'a используйте:** - -.. code:: python - - from spapi import Api - - api = Api(card_id='CARD_ID', - token='TOKEN') - - print(api.webhook_verify(data='webhook_data', - header='webhook_header' - ) - ) - -*В ответ вы получите:* - -* ``True`` - webhook достоверен -* ``False`` - webhook не является достоверным - -`Переводы `_ -~~~~ - -.. code:: python - - from spapi import Api - - api = Api(card_id='CARD_ID', - token='TOKEN') - - print(api.transaction(receiver='12345', - amount=1, - comment="test" - ) - ) - -* ``receiver`` - Номер карты получателя -* ``amount`` - Количество АР для перевода -* ``comment`` - Комментарий к переводу - -`Проверка наличия проходки `_ -~~~~ - -.. code:: python - - from spapi import Api - - api = Api(card_id='CARD_ID', - token='TOKEN') - - print(api.check_user(discord_user_id=123456789012345678)) + import pyspapi -* ``discord_user_id`` - ID пользователя в Discord + print(pyspapi.SPAPI(card_id='card_id', token='token').balance) -*В ответ вы получите JSON:* -* ``username`` - Ник пользователя или null, если у пользователя нет входа на сервер +Больше примеров можно найти в каталоге `examples `_ Ссылки ======= * `Discord сервер `_ * `Документация pyspapi `_ +* `PyPi `_ * `Документация API сайтов СП `_