Webhooks

Caution

To correctly run the webhook you need a VPS server or configure the local machine for response to requests of QIWI API.

Caution

Firstly, you need to register webhook to your server using glQiwiApi

🐺So, to “bind” webhook and gracefully work with glQiwiApi webhook API, you need to follow this instructions:

1. Step one(bind webhook).

import asyncio

from glQiwiApi import QiwiWrapper
from glQiwiApi.ext.url_builder import WebhookURL

wrapper = QiwiWrapper(
    api_access_token="",
    secret_p2p="",
    phone_number="+"
)


async def main():
    # some tips:
    # - webhook_path have to starts with "/"
    url = WebhookURL.create(host="https://github.com", webhook_path="/GLEF1X/glQiwiApi")  # equal to https://github.com/GLEF1X/glQiwiApi
    # Also, you can pass url as string, but it's highly recomended to use WebhookURL extension
    await wrapper.bind_webhook(url=url, delete_old=True)


asyncio.run(main())

2. Step two(use handlers and start webhook).

Using glQiwiApi you can use two types of handlers transaction_handler and bill_handler respectively. Also, you can pass lambda filters to miss unnecessary updates from webhook.

Usage of webhooks

import logging

from aiogram import Bot

from glQiwiApi import QiwiWrapper, types
from glQiwiApi.core.dispatcher.webhooks.config import Path
from glQiwiApi.utils import executor

TOKEN = "token from https://qiwi.com/api/"
QIWI_SECRET = "secret token from https://qiwi.com/p2p-admin/"

wallet = QiwiWrapper(api_access_token=TOKEN, secret_p2p=QIWI_SECRET)

bot = Bot(token="BOT_TOKEN")

logger = logging.getLogger(__name__)


# There is a lambda expression for "cutting off" test payments
@wallet.transaction_handler(lambda event: event.payment is not None)
async def main(event: types.WebHook):
    logger.info("New transaction: {}", event)
    await bot.send_message(chat_id="1219185039", text=event.hook_id)


@wallet.bill_handler()
async def main2(event: types.Notification):
    logger.info("P2P EVENT {}", event)


# Also, you can specify a path for webhook
# Example: http://127.0.0.1/your_path/
# If you don't pass path in `start_webhook`
# or dont pass on transaction_path or bill_path
# Its ok, because it will take a default paths
# default transaction_path = /dispatcher/qiwi/
# default bill_path = /webhooks/qiwi/bills/
# So, if you dont pass on paths
# you need to register webhook with url like
# on this example: http://your_ip:port/web_hooks/qiwi/ - for transactions
# or http://your_ip:port/webhooks/qiwi/bills/ - for bills
path = Path(transaction_path="/dispatcher/qiwi", bill_path="/my_webhook/")

executor.start_webhook(
    wallet,
    # You can pass on any port, but it must be open for web
    # You can use any VPS server to catching webhook or
    # your configured local machine
    path=path,
)