Update README.md

Немного исправлено описание библиотеки и добавлено описание функции webhook_veify()
This commit is contained in:
Aleksey
2022-06-08 10:24:55 +03:00
committed by GitHub
parent f244e3f4db
commit 1d6af2b8ec

View File

@@ -1,5 +1,5 @@
# pyspapi # pyspapi
Фреймворк [API](https://github.com/sp-worlds/api-docs) для серверов СП [API](https://github.com/sp-worlds/api-docs) обертка для серверов СП, написанная на Python.
## Установка ## Установка
**Требуется *Python 3.7* или выше** **Требуется *Python 3.7* или выше**
@@ -34,7 +34,7 @@ print(api.payment(amount=1,
- `redirectUrl` - URL страницы, на которую попадет пользователь после оплаты - `redirectUrl` - URL страницы, на которую попадет пользователь после оплаты
- `webhookUrl` - URL, куда наш сервер направит запрос, чтобы оповестить ваш сервер об успешной оплате - `webhookUrl` - URL, куда наш сервер направит запрос, чтобы оповестить ваш сервер об успешной оплате
- `data` - Строка до 100 символов, сюда можно поместить любые полезные данных. - `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 запрос. После успешной оплаты на URL указанный в `webhookUrl` придет POST запрос.
*Тело запроса будет в формате JSON:* *Тело запроса будет в формате JSON:*
@@ -43,6 +43,23 @@ print(api.payment(amount=1,
- `amount` - Стоимость покупки - `amount` - Стоимость покупки
- `data` - Данные, которые вы отдали при создании запроса на оплату - `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) ### [Переводы](https://github.com/sp-worlds/api-docs/blob/main/TRANSACTIONS.md)
```Python ```Python
@@ -61,7 +78,7 @@ print(api.transaction(receiver='12345',
- `receiver` - Номер карты получателя - `receiver` - Номер карты получателя
- `amount` - Количество АР для перевода - `amount` - Количество АР для перевода
- `comment` - Комментарий к переводу - `comment` - Комментарий к переводу
-
### [Проверка наличия проходки](https://github.com/sp-worlds/api-docs/blob/main/USERS.md) ### [Проверка наличия проходки](https://github.com/sp-worlds/api-docs/blob/main/USERS.md)
```Python ```Python