POS System APIPojedynczy punkt wejścia z Twojego POS do fiskaltrust.Middleware.

Odkryj wszystkie nasze produkty Skontaktuj się z nami

Twórz paragony, realizuj płatności, wystawiaj paragony cyfrowe i eksportuj dzienniki za pośrednictwem jednego interfejsu API HTTP opartego na procesach.

API pozwala skupić się na systemie, podczas gdy fiskaltrust zajmuje się infrastrukturą paragonów. Zamiast traktować paragony jako funkcję poboczną lub dodatek dla konsumentów, interfejs Receipt-API obsługuje paragony jako pierwszorzędny, regulowany element systemu. Integrujesz się raz i polegasz na ujednoliconym, otwartym interfejsie API, który jest utrzymywany w miarę ewolucji przepisów i wymagań operacyjnych.

fiskaltrust POS System API służy jako centralny interfejs między systemami POS a oprogramowaniem fiskaltrust Middleware. Oferuje kompleksowy zestaw funkcji, w tym fiskalizację (lub podpisywanie) paragonów, realizację płatności za pośrednictwem różnych dostawców, drukowanie paragonów cyfrowych i eksport danych z Middleware.

Poprzez proste i spójne punkty końcowe API obsługuje kluczowe funkcje: /echo do testów łączności, /order do rejestrowania danych zamówienia, /pay do alokacji płatności, /sign do zgodnego pieczętowania transakcji, /issue do generowania cyfrowych lub drukowanych paragonów oraz /journal do eksportu gotowego do kontroli.

Łatwe do odczytania punkty końcowe API

Międzynarodowy PosSystem-API

/echo,kontrola stanu i reset.
/order,rejestrowanie informacji o zamówieniu oraz odpytywanie o stan lub wynik.
/pay,wykonanie płatności, oczekiwanie na zakończenie z limitem czasu, pobranie wyniku.
/sign,finalizowanie paragonów zgodnie z przepisami krajowymi i z łańcuchowaniem hashy.
/issuetworzenie i aktualizowanie wystawionego paragonu, w tym statusu dostarczenia.
/journal,pobieranie pojedynczych wpisów lub zakresów na potrzeby audytów i zamknięć.

Dokumentacja POS System API

POS Dealer API. Stworzony z myślą o stabilnych, przejrzystych, w pełni audytowalnych integracjach.

Zaprojektowany do użytku na różnych platformach, interfejs API obsługuje wdrożenia lokalne i instancje hostowane w chmurze w europejskich centrach danych. Zapewnia niezmienne przechowywanie danych zgodne z przepisami i integruje się z oprogramowaniem fiskaltrust Middleware w celu automatycznych aktualizacji zgodności.

Części API i Middleware są open source, oferując przejrzystość i długoterminową stabilność. Dzięki otwartej dokumentacji i ujednoliconemu modelowi danych zmniejsza to nakłady na konserwację i sprawia, że rozwiązania POS są w pełni audytowalne.

Jeden interfejs API, spójne zachowanie, niezależnie od wymagań specyficznych dla danego kraju.

Podstawowe pojęcia

API traktuje transakcję jako podróż. Każdy krok zmienia stan na serwerze. Przy każdym wywołaniu przekazywany jest unikalny identyfikator operacji. Jeśli sieć przestanie działać, należy powtórzyć to samo wywołanie z tym samym identyfikatorem.

Backend deduplikuje i zwraca pierwszy ukończony wynik. Taka konstrukcja zapewnia bezpieczne ponawianie prób i przewidywalne wyniki dla krytycznych kroków fiskalnych.

Centralny punkt wejścia do Middleware do fiskalizacji, płatności, wydawania i eksportu.
Procesowe, stanowe wzorce wywołań, które zachowują się jak maszyna stanowa.
Idempotencja poprzez nagłówek x-operation-id z deterministycznymi odpowiedziami przy ponownej próbie.
Hooki wywołań zwrotnych do obserwowania przejść stanu podczas długich operacji.

Żądanie z x-operation-id wchodzi do Middleware

Przetwarzanie w Middleware

Ponów próbę z tym samym x-operation-id

Ukończony wynik

Punkt końcowy wywołania zwrotnego x-operation-callback-state

Uwierzytelnianie i wersjonowanie

Zakres dostępu jest określany na poziomie CashBoxa. Używasz CashBoxId i AccessToken z Portalu. API jest zgodne z wersjonowaniem semantycznym. Zmiany niezgodne wstecz są ograniczone do głównych wersji i w razie potrzeby można je przypiąć w adresie URL.

Poświadczenia: CashBoxId i AccessToken.
Semantyczne wersjonowanie, domyślnie najnowsze, z obsługą jawnego przypinania.

Programista POS

Uwierzytelnianie CashBoxId + AccessToken

Wzorce AsynchronousAPI

Nagłówki i idempotencja

Każde wywołanie krytyczne akceptuje nagłówki kontrolne. x-operation-id jest kluczem idempotencji. x-operation-lifetime określa, jak długo operacja jest ważna. Możesz ustawić adres URL wywołania zwrotnego dla każdego wywołania, aby otrzymywać komunikaty o stanie bez odpytywania.

x-operation-id, unikalny dla każdej operacji w celu deduplikacji ponownych prób.
x-operation-lifetime, okno akceptacji w milisekundach.
x-operation-callback-state, powiadamia o każdej zmianie stanu.
Opcjonalne x-terminal-id i x-possystem-id do przypisania.

Status dostarczenia i paragonu

Po wydaniu można pobrać wydaną zawartość, zaktualizować ją lub zapytać o stan dostarczenia. Istnieją blokujące punkty końcowe, które czekają do maksymalnego limitu czasu i zgłaszają dostarczenie lub niedostarczenie. Upraszcza to przepływ użytkowników przy kasie i pozwala uniknąć ciągłego odpytywania.

Środowiska

Interfejs API udostępnia środowiska sandbox i produkcyjne dla każdego punktu końcowego. Użyj piaskownicy do integracji i testów automatycznych. Promuj te same wywołania do środowiska produkcyjnego, gdy będą gotowe. AynchronousAPI, nagłówki i wywołania zwrotne zachowują się tak samo w obu przypadkach.

Obsługa błędów

Wywołania zwracają standardowe kody stanu HTTP. Nieprawidłowo sformułowane żądania lub brakujące nagłówki powodują błędy klienta. Błędy uwierzytelniania zwracają błąd braku autoryzacji. Serwer zgłasza nieoczekiwane błędy ze szczegółami problemu, jeśli są dostępne. Ponowne próby z tym samym identyfikatorem operacji zwracają pierwszy zakończony wynik.

Korzystaj z otwartego, udokumentowanego interfejsu, który dostosowuje się do zmieniających się przepisów.

Jak to działa w 3 krokach

Konfigurujesz CashBox w Portalu i uzyskujesz dane uwierzytelniające. Twój POS wywołuje koszyk, zamówienie i płatność, aby zbudować podróż. Kończysz podpisem i wydaniem, a następnie odczytujesz wpisy dziennika na potrzeby codziennego zamknięcia lub audytów. Nieudane kroki można bezpiecznie powtórzyć, ponownie wykorzystując identyfikator operacji.

Zarejestruj się na stronie fiskaltrust.Portal.

Utwórz CashBox i połącz ją z POS lub ERP.

Prowadź podróż: koszyk, zamówienie, płatność, podpis, wydanie.

Podstawowe informacje dla deweloperów

Zacznij od specyfikacji OpenAPI i dokumentacji na żywo. Przejrzyj diagramy SynchronousAPI i kontrakt nagłówków. Zaimplementuj ponawianie prób z idempotencją i wywołaniami zwrotnymi. Użyj piaskownicy, aby zweryfikować przejścia stanów i zachowanie dostarczania paragonów przed wdrożeniem produkcyjnym.

Strona dokumentacji API POS System i plik OpenAPI.
Diagramy czasowe i diagramy stanów interfejsu SynchronousAPI.
Punkty końcowe piaskownicy dla echo, koszyka, zamówienia, płatności, podpisania, wydania, dziennika.

Pytania dotyczące integracji? Nasz zespół techniczny jest do Twojej dyspozycji.

Kontakt