Integracje i API
Podłącz swój system do kasy
SiopKA ma ogólne API kasy. Twoja aplikacja sprzedażowa, system rezerwacji albo dyspozytornia wystawia dokumenty przez kasę klienta, bez pisania własnej kasy fiskalnej.
Jak Twój system łączy się z kasą?
Na tym samym telefonie albo jako stanowisko zdalne. Obie drogi kończą się w tej samej kolejce kasy.
Lokalne API kasy 1.3
Aplikacja na tym samym telefonie z Androidem. Wniosek przez system Android (pakiet, identyfikator, certyfikat podpisu), sesja kasjera zatwierdzana na ekranie kasy, szyfrowane połączenie tylko w obrębie telefonu.
Stanowiska zdalne 1.0
System POS, tablet albo serwer partnera wysyła podpisane żądania przez nasz backend do kasy firmy. Parowanie w panelu kodem albo kodem QR, dwustopniowa autoryzacja.
Do czego dostaje dostęp integrator?
Do tego, na co zgodzi się administrator kasy, w podziale na zakresy. Wybór z najczęściej używanych:
| Zakres | Na co pozwala |
|---|---|
status.read | Odczyt gotowości kasy, licencji kasy i jej możliwości. |
session.request | Prośba o sesję kasjera, zatwierdzana PIN-em na ekranie kasy. |
catalog.read | Odczyt stawek VAT i katalogu towarów. |
receipts.create | Wystawienie paragonu jednym żądaniem. |
sales.open | Sprzedaż dwuetapowa: otwarcie, operacje, zatwierdzenie albo anulowanie. |
sales.taxi | Start i zakończenie kursu taxi, tylko dla aplikacji zadeklarowanych w kasie. |
operations.read | Stan własnych operacji i sprzedaży po identyfikatorze żądania. |
documents.read | Strony zachowanych dokumentów własnej sprzedaży jako obrazy. |
output.print | Wydruk albo wysłanie dokumentu do Siop Printer. |
reports.daily.generate | Raport dobowy na żądanie. |
invoices.request | Faktura do własnego paragonu. |
payments.terminal | Płatność na terminalu płatniczym kasy; integracja terminala jest poza pilotażem i kasa zgłasza ją jako niedostępną. |
Jakie zasady obowiązują każdą integrację?
Te same, które chronią kasę przed podwójnym paragonem i utratą dokumentu.
- Idempotencja: każde żądanie ma własny identyfikator. Powtórzenie tego samego żądania zwraca ten sam wynik, a nie drugi paragon.
- Wynik nieznany: gdy odpowiedź nie dotarła, najpierw odczytaj stan operacji po identyfikatorze, potem decyduj o ponowieniu.
- Jasne odmowy: znane odmowy mają własne kody, np. zmiana stawki VAT albo brak katalogu, zanim cokolwiek zostanie zapisane.
- Kasjer z sesji: kasjer wynika z zatwierdzonej sesji kasy, nigdy z treści żądania.
- Jedna centralna kasa nie zastąpi wielu: kasa obsługuje kasjerów jednego podatnika, nie wiele niezależnych punktów płatności ani wielu taksówek.
Jak zacząć integrację?
Od rozmowy o scenariuszu. Opis kontraktu przekazujemy po rozmowie, a próby prowadzimy razem w środowisku MF TEST.
- Opisz scenariuszBranża, rodzaj integracji (lokalnie albo stanowisko zdalne), dokumenty i zachowanie po utracie połączenia.
- Dostajesz kontraktOpis tras, zakresów, kodów odmów i przykładów, z wersją kontraktu.
- Testujemy razem w środowisku MF TESTPełna droga dokumentu bez rzeczywistej sprzedaży, także scenariusze błędów i wznowień.
Zacznij od pierwszego paragonu
Kup licencję w sklepie, a instalację wersji pilotażowej uzgodnimy z Tobą po zakupie. Możesz też umówić bezpłatną prezentację: pokażemy kasę, aplikację taxi i panel na Twoim przykładzie.