deesiigneer/pyspapi
1
0
Fork 0
mirror of https://github.com/deesiigneer/pyspapi.git synced 2026-04-20 12:35:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update and rename README.md to README.rst

Browse Source
This commit is contained in:
Aleksey
2022-07-08 11:26:54 +03:00
committed by GitHub
parent 9a61797253
commit 0667922c8c
2 changed files with 140 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files

109
README.md
View File

@@ -1,109 +0,0 @@
# pyspapi
[![PyPI](https://img.shields.io/pypi/v/pyspapi)](https://pypi.python.org/pypi/pyspapi)
[![PyPI - Downloads](https://img.shields.io/pypi/dd/pyspapi?label=PyPi%20downloads)](https://pypi.python.org/pypi/pyspapi)
[![GitHub all releases](https://img.shields.io/github/downloads/deesiigneer/pyspapi/total?color=34C924&label=GitHub%20downloads)](https://github.com/deesiigneer/pyspapi/)
[![Developer discord server](https://img.shields.io/discord/850091193190973472?color=5865F2&label=dev%20discord)](https://discord.gg/sJYtYnhN)
[API](https://github.com/sp-worlds/api-docs) обертка для серверов СП, написанная на Python.
## Установка
**Требуется *Python 3.7* или выше**
*Windows*
```commandline
pip install pyspapi
```
*Linux*
```commandline
sudo apt pip3 install pyspapi
```
## Примеры
### [Оплата](https://github.com/sp-worlds/api-docs/blob/main/PAYMENTS.md)
```Python
import spapi
api = spapi.Api(card_id='CARD_ID',
token='TOKEN')
print(api.payment(amount=1,
redirecturl='https://www.google.com/',
webhookurl='https://www.yourwebhook.com/',
data='Какие-то данные'
)
)
```
- `amount` - Стоимость покупки в АРах
- `redirectUrl` - URL страницы, на которую попадет пользователь после оплаты
- `webhookUrl` - URL, куда наш сервер направит запрос, чтобы оповестить ваш сервер об успешной оплате
- `data` - Строка до 100 символов, сюда можно поместить любые полезные данных.
#### [Получение данных об успешной оплате](https://github.com/sp-worlds/api-docs/blob/main/PAYMENTS.md#%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85-%D0%BE%D0%B1-%D1%83%D1%81%D0%BF%D0%B5%D1%88%D0%BD%D0%BE%D0%B9-%D0%BE%D0%BF%D0%BB%D0%B0%D1%82%D0%B5)
После успешной оплаты на URL указанный в `webhookUrl` придет POST запрос.
*Тело запроса будет в формате JSON:*
- `payer` - Ник игрока, который совершил оплату
- `amount` - Стоимость покупки
- `data` - Данные, которые вы отдали при создании запроса на оплату
Для проверки достоверности webhook'a используйте:
```Python
import spapi
api = spapi.Api(card_id='CARD_ID',
token='TOKEN')
print(api.webhook_verify(data='webhook_data',
header='webhook_header'
)
)
```
В ответ вы получите:
- True - webhook достоверен
- False - webhook не является достоверным
### [Переводы](https://github.com/sp-worlds/api-docs/blob/main/TRANSACTIONS.md)
```Python
import spapi
api = spapi.Api(card_id='CARD_ID',
token='TOKEN')
print(api.transaction(receiver='12345',
amount=1,
comment="test"
)
)
```
- `receiver` - Номер карты получателя
- `amount` - Количество АР для перевода
- `comment` - Комментарий к переводу
### [Проверка наличия проходки](https://github.com/sp-worlds/api-docs/blob/main/USERS.md)
```Python
import spapi
api = spapi.Api(card_id='CARD_ID',
token='TOKEN')
print(api.check_user(discord_user_id=123456789012345678)
)
```
- `discord_user_id` - ID пользователя в Discord.
*В ответ вы получите JSON:*
- `username` - Ник пользователя или null, если у пользователя нет входа на сервер.
## Ссылки
- [Discord сервер разработчика](https://discord.com/invite/d7SgXW7e)
- [Документация API сайтов СП](https://github.com/sp-worlds/api-docs)

140
README.rst Normal file
View File

@@ -0,0 +1,140 @@
.. image:: https://i.imgur.com/melhWhU.png
:alt: pyspapi
.. image:: https://img.shields.io/discord/850091193190973472?color=5865F2&label=discord
:target: https://discord.gg/VbyHaKRAaN
:alt: Discord server invite
.. image:: https://img.shields.io/github/v/release/deesiigneer/pyspapi?include_prereleases&label=github%20release
:target: https://github.com/deesiigneer/pyspapi/
:alt: GitHub release (latest by date including pre-releases)
.. image:: https://img.shields.io/pypi/v/pyspapi.svg
:target: https://pypi.org/project/pyspapi/
:alt: PyPI downloads info
.. image:: https://img.shields.io/pypi/dm/pyspapi?color=informational&label=pypi%20downloads
:target: https://pypi.org/project/pyspapi/
:alt: PyPI version info
.. image:: https://img.shields.io/readthedocs/pyspapi
:target: https://pyspapi.readthedocs.io/
:alt: pyspapi documentation
pyspapi
=======
`API <https://github.com/sp-worlds/api-docs>`_ обертка для серверов СП, написанная на Python.
Установка
==========
**Требуется Python 3.7 или выше**
*Windows*
.. code:: sh
pip install pyspapi
*Linux*
.. code:: sh
sudo apt pip3 install pyspapi
Примеры
-----
`Оплата <https://github.com/sp-worlds/api-docs/blob/main/PAYMENTS.md>`_
~~~~
.. 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 символов, сюда можно поместить любые полезные данных.
`Получение данных об успешной оплате <https://github.com/sp-worlds/api-docs/blob/main/PAYMENTS.md#%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85-%D0%BE%D0%B1-%D1%83%D1%81%D0%BF%D0%B5%D1%88%D0%BD%D0%BE%D0%B9-%D0%BE%D0%BF%D0%BB%D0%B0%D1%82%D0%B5>`_
~~~~
После успешной оплаты на 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 не является достоверным
`Переводы <https://github.com/sp-worlds/api-docs/blob/main/TRANSACTIONS.md>`_
~~~~
.. 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`` - Комментарий к переводу
`Проверка наличия проходки <https://github.com/sp-worlds/api-docs/blob/main/USERS.md>`_
~~~~
.. code:: python
from spapi import Api
api = Api(card_id='CARD_ID',
token='TOKEN')
print(api.check_user(discord_user_id=123456789012345678))
* ``discord_user_id`` - ID пользователя в Discord
*В ответ вы получите JSON:*
* ``username`` - Ник пользователя или null, если у пользователя нет входа на сервер
Ссылки
=======
* `Discord сервер <https://discord.gg/VbyHaKRAaN>`_
* `Документация pyspapi <https://pyspapi.readthedocs.io/>`_
* `Документация API сайтов СП <https://github.com/sp-worlds/api-docs>`_