Checklista implementacji API InPost Pay
Aby wdrożenie przebiegło sprawnie, przygotowaliśmy listę kluczowych kroków, które pomogą Wam szybko rozpocząć integracji swojego sklepu z InPost Pay.
Uzyskaj dane dostępowe do środowiska sandbox
Wypełnij formularz na stronie https://inpostpay.pl/kontakt w sekcji „Dla biznesu” -> „Sandbox” i otrzymaj swoje dane dostępowe.Przejrzyj dokumentację API
Zapoznaj się z naszą dokumentacją dostępną pod InPost Pay - Developer Documentations - Confluence. Znajdziesz tam szczegółowe informacje na temat endpointów, metod oraz kodów odpowiedzi, które będą pomocne w procesie integracji.Zapoznaj się z przewodnikiem poprawnej implementacji
W przewodniku znajdziesz obowiązkowe standardy oraz dodatkowe miejsca, gdzie InPost Pay może być widoczny. Wybierz te, które najlepiej pasują do Twojego sklepu. Szczegóły znajdziesz w sekcji Standardy implementacji InPost Pay.Przycisk na stronie produktu (obowiązkowe)
Przycisk na stronie koszyka (obowiązkowe)
Strona podziękowania (obowiązkowe)
Przekazywanie numeru paczki (obowiązkowe)
Skonfiguruj wszystkie funkcje API oraz widget
Skonfiguruj i przetestuj wszystkie endpointy, takie jak parowanie koszyków, składanie zamówienia, obsługa błędów i wykluczenia. Zacznij od środowiska testowego, aby upewnić się, że wszystkie funkcje działają poprawnie.Autoryzacja - implementacja autentykacji i autoryzacji.
Widget frontend - implementacja Widgetu InPost Pay.
Widget backend - wystawienie endpointów opisanych w Merchant Backend API, których celem jest obsługa funkcjonalności zgodnie z diagramami sekwencji dla InPost Pay oraz Widget 2.0.
Integracja z InPost Pay (Basket App) - integracja z metodami API opisanymi w rozdziale InPost Pay (Basket App).
Przetestuj integrację
Przeprowadź pełne testy w środowisku sandbox, weryfikując wszystkie funkcjonalności: przepływy płatności, obsługę błędów i powiadomienia. Upewnij się, że przetestowano wszystkie wymagane scenariusze, które znajdziesz w Scenariusze testowe InPost Pay.Uzyskaj dostęp do środowiska produkcyjnego
Po zakończeniu testów skorzystaj z linku Autoryzacja i wymagania techniczne, aby uzyskać dostęp do środowiska produkcyjnego.Przekaż integrację do audytu
Ustal z nami datę i godzinę uruchomienia usługi w środowisku produkcyjnym. Przeprowadzimy dwie transakcje testowe, aby zweryfikować poprawność integracji. Jeśli audyt zakończy się pomyślnie, Wasz sklep pojawi się w aplikacji InPost mobile, a integrację uznamy za ukończoną.Integracja transakcji i zwrotów
Zwroty i przegląd transakcji możesz realizować za pośrednictwem Merchant Panel lub zintegrować ten system przez API. Rekomendujemy skorzystanie z API. Szczegóły znajdziesz w sekcji: Zwroty i transakcje.Skonfiguruj narzędzia analityczne, jeśli z nich korzystasz
Eventy frontowe generowane w Twoim sklepie będą zapisywane w narzędziach analitycznych tak jak dotychczas.
Jeśli chcesz, aby do narzędzi analitycznych trafiały także eventy emitowane przez aplikację InPost Mobile, skorzystaj z naszego przygotowanego playbooka: InPost Pay - Analityka.Umieść banery InPost Pay na swoim sklepie internetowym
Jeśli chcesz zakomunikować klientom swojego sklepu, że zakupy z InPost Pay są już dostępne w Twoim sklepie, możesz skorzystać z przygotowanych przez nas materiałów: Materiały InPost Pay na stronę sklepu.
Widoczność widgetu InPost Pay podczas implementacji i testów
Podczas implementacji oraz testowania usługi InPost Pay na sklepie produkcyjnym, widget płatności InPost Pay powinien być ukryty dla klientów sklepu. Widoczność widgetu musi być ograniczona wyłącznie do testerów i osób zaangażowanych w proces wdrożenia.
Cel:
Ukrycie widgetu zapobiega sytuacji, w której potencjalni klienci sklepu mogliby próbować korzystać z niekompletnej lub niedziałającej jeszcze usługi InPost Pay. Dzięki temu minimalizujemy ryzyko negatywnych doświadczeń użytkowników i unikamy problemów związanych z nieprawidłowością działania funkcji płatności.
Jak to zrobić?
Widoczność widgetu powinna być kontrolowana na poziomie kodu lub konfiguracji sklepu. Można to osiągnąć poprzez implementację mechanizmu autoryzacji dostępu do widgetu, który pozwala wyświetlać go jedynie pod dedykowanym url-em wywołując go z odpowiednim parametrem na przykład https://shop.url?showInPostPay=true.
Ograniczony dostęp: Podczas testów widget InPost Pay jest wyświetlany wyłącznie dla określonych użytkowników (np. poprzez filtrowanie na podstawie adresu IP lub kont testowych).
Pełna aktywacja widgetu następuje dopiero po zakończeniu testów, przejściu audytu z wynikiem pozytywnym i pełnym wdrożeniu usługi, gdy zostanie ona uznana za gotową do użycia przez wszystkich klientów sklepu.