Skip to content

README_PL.md

Latest commit

 

History

History
127 lines (92 loc) · 5.62 KB

README_PL.md

File metadata and controls

127 lines (92 loc) · 5.62 KB

Tpay OpenAPI library

Biblioteka dla wszystkich metod dostępnych przez OpenAPI Tpay.

Najnowsza stabilna wersja Wersja PHP Licencja CI status Pokrycie typami

English version 🇬🇧 wersja angielska

Instalacja

Instalacja poprzez Composer:

composer require tpay-com/tpay-openapi-php

Instalacja poprzez Git z SSH:

git clone git@github.com:tpay-com/tpay-openapi-php.git

Instalacja poprzez Git z HTTPS:

git clone https://github.com/tpay-com/tpay-openapi-php.git

Ręczne pobieranie: https://github.com/tpay-com/tpay-openapi-php/archive/master.zip

Konfiguracja

Jedyne, co musisz zrobić, to ustawić dane uwierzytelniające OAuth, tak jak w przykładowym pliku konfiguracyjnym (zobacz przykład). Klucze dostępu możesz wygenerować w panelu sprzedawcy Tpay.

Plik src/Loader.php obsługuje ładowanie wszystkich wymaganych klas, więc możesz dołączyć ten plik do dowolnego pliku, który edytujesz.

Wszystkie metody opisane w dokumentacji Tpay OpenAPI można łatwo wykonać, uruchamiając jedną z metod z tej biblioteki, takie jak:

$tpayApi = new TpayApi($clientId, $clientSecret, true, 'read');
$transactions = $tpayApi->Transactions->getTransactions();

Wszystkie obecnie dostępne metody API mają przykładowe użycie w katalogu Examples.

Przykładowe dane uwierzytelniające

dla wszystkich wywołań API:

  Client id: 1010-e5736adfd4bc5d8c
  Client secret: 493e01af815383a687b747675010f65d1eefaeb42f63cfe197e7b30f14a556b7

dla sprawdzania poprawności powiadomień:

  Confirmation code: demo

dla szyfrowania kart kredytowych:

  Public Key: LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0NCk1JR2ZNQTBHQ1NxR1NJYjNEUUVCQVFVQUE0R05BRENCaVFLQmdRQ2NLRTVZNU1Wemd5a1Z5ODNMS1NTTFlEMEVrU2xadTRVZm1STS8NCmM5L0NtMENuVDM2ekU0L2dMRzBSYzQwODRHNmIzU3l5NVpvZ1kwQXFOVU5vUEptUUZGVyswdXJacU8yNFRCQkxCcU10TTVYSllDaVQNCmVpNkx3RUIyNnpPOFZocW9SK0tiRS92K1l1YlFhNGQ0cWtHU0IzeHBhSUJncllrT2o0aFJDOXk0WXdJREFRQUINCi0tLS0tRU5EIFBVQkxJQyBLRVktLS0tLQ==

Przykłady użycia

Formularze frontendowe i moduły obsługi płatności:

Formularz wyboru metody płatności, Formularz metody BLIK, Prosty formularz karty kredytowej, Rozszerzony formularz karty kredytowej, Przykład płatności cyklicznej, Webhook z powiadomieniem o płatności.

Rejestracja kont handlowców (tylko dla partnerów)

Przykład użycia.

Logi

Biblioteka posiada własny system logowania do zapisywania wszystkich wywołań API, odpowiedzi, powiadomień webhook i wyjątków. Upewnij się, że katalog Logs jest zapisywalny i dodaj regułę do Apache .htaccess lub NGINX, aby zabronić dostępu do tego obszaru z przeglądarki. Pliki logów tworzone są dla każdego dnia oddzielnie.

Logowanie jest domyślnie włączone, ale możesz wyłączyć tę funkcję za pomocą polecenia:

Logger::disableLogging();

Możesz także ustawić własną ścieżkę logowania za pomocą tego polecenia:

Logger::setLogPath('/my/own/path/Logs/');

Nazwy plików dzienników zostaną przypisane automatycznie.

Możesz zastąpić powyższy system logowania, konfigurując własną implementację Psr\Log\LoggerInterface za pomocą:

Logger::setLogger($logger);

Niestandardowa ścieżka szablonów

Możesz ustawić własną ścieżkę szablonów, dzięki czemu możesz kopiować i modyfikować pliki szablonów phtml z tej biblioteki.

Util::$customTemplateDirectory = '/my/own/templates/path/';

Możesz ustawić własną ścieżkę dla plików statycznych, dzięki czemu możesz kopiować i modyfikować pliki css i js z tej biblioteki. Domyślnie ścieżka jest oparta na wartości $_SERVER['REQUEST_URI'].

Util::$libraryPath = '/my/own/path/';

Język

Obecnie biblioteka obsługuje dwa języki (angielski i polski). Domyślnym językiem jest angielski. Przykład zmiany języka:

// Za każdym razem, gdy konstruujesz klasę udostępniającą formularze płatności, możesz przekazać język w konstruktorze
$paymentForms = new PaymentForms('pl');
// Po tej linii wszystkie komunikaty statyczne (etykiety wejść, tytuły przycisków itp.) będą wyświetlane w języku polskim

// Jeśli chcesz ręcznie uzyskać dostęp do tłumaczeń, użyj:
$lang = new Lang();
$lang->setLang('pl'); // do ustawienia języka
$lang->lang('pay'); // aby wyświetlić przetłumaczony klucz

Licencja

Ta biblioteka jest udostępniana na licencji MIT.