https://github.com/ivall/microsms-sdk-python

Simple microsms api wrapper
https://github.com/ivall/microsms-sdk-python

Last synced: about 1 month ago
JSON representation

Simple microsms api wrapper

• Host: GitHub
• URL: https://github.com/ivall/microsms-sdk-python
• Owner: ivall
• Created: 2020-12-27T12:48:46.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-03-16T21:08:48.000Z (almost 4 years ago)
• Last Synced: 2024-11-05T16:03:27.387Z (3 months ago)
• Language: Python
• Homepage:
• Size: 15.6 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# microsms-sdk-python

## dokumentacja

#### Instalacja biblioteki

Bibliotekę instalujemy poprzez polecenie ```pip install git+https://github.com/ivall/microsms-sdk-python#egg=microsms_sdk```

#### Importowanie biblioteki

Aby skorzystać z biblioteki importujemy klasę Microsms.

```python

from microsms_sdk.main import Microsms

```

### Tworzenie instancji

Utworzenie instancji klasy Microsms pozwoli na generowanie płatności.

```python

client = Microsms()

```

### Płatność SMS

Do sprawdzenia kodu SMS potrzebujemy 3 parametrów, które są opisane w dokumentacji microsms: https://microsms.pl/kernel/Mails/files/dokumentacja_techniczna_mirosms.pdf.

Przykład:

```python

sms_payment = client.sms(user_id, service_id, code)

```

Metoda sms zawsze zwraca boola.

### Płatność przelewem

```python

transfer_payment = client.bank_transfer(shop_id, hash, amount, control, return_urlc, return_url, description)

```

4 ostatnie parametry są opcjonalne, wymagane jest tylko shop_id, hash, amount.

Metoda bank_transfer zwraca string, link do płatności.

Dokumentacja microsms dotycząca przelewów: https://microsms.pl/documents/dokumentacja_przelewy_microsms.pdf