Przejdź do głównej zawartości

Aktywacja i stan

Aktywacja łączy system POS z profilem integracji OpenApp jednej lokalizacji. Każda lokalizacja ma własny profil integracji, obsługiwany przez jeden backend POS dla wszystkich jej kas.

Merchant generuje PIN w panelu merchanta. Operator POS wpisuje w POS identyfikator podatkowy merchanta i PIN, a POS wywołuje:

POST /merchant/v1/pos/activate

Body żądania to ActivatePos, a odpowiedź to PosActivationResponse.

Zasady PIN-u​

  • PIN ma 8 cyfr i wygasa 15 minut po wygenerowaniu.
  • PIN działa jednokrotnie. Po nieudanej próbie lub wygaśnięciu potrzebny jest nowy PIN.
  • Merchant ma naraz jeden oczekujący PIN. Wygenerowanie nowego PIN-u unieważnia poprzedni.

Odpowiedzi​

Nieudana aktywacja zwraca HTTP 200 z success: false i powodem niepowodzenia. OpenApp zwraca HTTP 429, gdy adres IP lub identyfikator podatkowy wykona zbyt wiele prób.

Ponowna aktywacja​

Ponowna aktywacja tej samej lokalizacji zastępuje oba zestawy poświadczeń. Poprzedni klucz API i klucz dostępu do kolejki natychmiast przestają działać, więc przeinstalowany lub przeniesiony backend POS musi zapisać nowe.

Stan​

Po aktywacji POS raportuje stan przy aktywacji oraz w regularnych interwałach heartbeat. Jeśli OpenApp nie otrzyma sprawdzenia stanu w czasie skonfigurowanym w profilu integracji, przestaje wysyłać komendy zamówień obsługiwane przez POS i informuje klientów, że lokalizacja jest niedostępna.

Ten diagram jest logiczny. Pomija szczegóły trybu dostarczania; model dostarczania opisuje Architektura.

Typy wiadomości:

Typ wiadomościKierunekCel
ActivatePosPOS -> OpenAppPrześlij identyfikator podatkowy merchanta i PIN, aby aktywować POS.
PosActivationResponseOpenApp -> POSZwróć wynik aktywacji oraz, przy sukcesie, poświadczenia i konfigurację dostarczania.
ReportPosHealthPOS -> OpenAppRaportuj stan POS przy aktywacji i w regularnych interwałach.