Przejdź do treści

Strona może być nieaktualna

Nikt jej nie zmieniał od 44 miesięcy (ostatni commit: 2023-02-22, Dariusz). Jeśli opisuje stan, którego już nie ma, zgłoś ją jako nieaktualną.

Wiadomości wysyłane na zewnętrzne adresy

Po niektórych operacjach na transporcie wysyłana jest informacja do zewnętrznych serwisów.

Kiedy jest wysyłana?

Wiadomość jest wysyłana po zatwierdzeniu statusu, jeśli task powiązany ze statusem ma ustawioną flagę send_api_message na true.

Flagę tą da się ustawić w widoku edycji tasku: Ustawienia -> wybrany typ transportu -> wybrany task -> edytuj:

Co jest wysyłane?

W wychodzącej wiadomości jest wysyłana pełna mapa transportu, którego dotyczyła wykonana operacja (zatwierdzenie statusu).

Dokąd jest wysyłane?

Adres, na który ma zostać wysłana wiadomość, określa Setting API_MESSAGE_URL.

Do celów testowych można go ustawić na <adres_backendu>/api/testMessage - wówczas wiadomość zostanie wysłana do samego Apollo i powinna pojawić się w logach.

Czy istnieją logi wysłanych komunikatów?

Tak, w szczegółach zlecenia jest widoczna sekcja "Integracja", jeśli użytkownik ma uprawnienie ROLE_SHOW_API_INTEGRATION_LOGS:

Wyświetlane są w niej wpisy z tabeli public_api_log dla danego transportu.

Czy jest dostęp do pełnego komunikatu?

Tak, w szczegółach zlecenia w sekcji "Integracja" możesz nacisnąć przycisk "Żądanie" aby wyświetlić pełne żądanie, które zostało wysłane z lub do publicznego API.

Czy komunikat da się ponowić?

Tak, jeśli użytkownik posiada uprawnienie ROLE_API_MESSAGE_RESENDING. Wówczas w sekcji "Integracja" widoczny jest przycisk ponów - po jego kliknięciu i potwierdzeniu operacji wiadomość jest ponawiana (w tej samej formie i na ten sam adres, który zapisany jest w logu).

UWAGA: Ręczne ponowienie komunikatu zależne jest od flagi canBeResend w Task'u. Obecnie ręczne ponawianie komunikatu jest włączone dla Task'ów o zatwierdzaniu statusów.

Czy komunikaty zostają ponowione w przypadku niepowodzenia?

Tak, ale tylko dla Task'ów, które mają włączoną flagę 'repeatSendApiMessage'. Flagę 'repeatSendApiMessage' możesz włączyć w ustawieniach wybranego Task'a:

Komunikat będziemy powtarzać aż do 5 razy - odpowiada za to parametr MAX_NUMBER_OF_RETRY_RESTFUL_JOB. Każde kolejne powtórzenie będzie wysyłane z dziesięciokrotnym opóźnieniem (parametr RESTFUL_JOB_TIME_DELAY_MULTIPLIER). Czas, po którym nastąpi pierwsze powtórzenie to czas zatwierdzenia statusu + parametr PREPARE_NOTIFICATIONS_JOB_DELAY_IN_SECONDS.

Specjalna notacja dla INTERLAN_API

W ramach zadania A-10933 dodaliśmy obsługę specjalnej notacji w wartości settingu API_MESSAGE_URL. Specjalna notacja pozwala na wysyłkę tego samego komunikatu dla kilku firm jednocześnie. Każda firma może określić swój adres URL, na który wysyłamy komunikat.
Jeśli chcemy z niej skorzystać, jako wartość API_MESSAGE_URL podajemy wartość w następującym formacie:

CompanyID1:::URL1|CompanyID2:::URL2|CompanyIDn:::URLn(...)
* znak | rozdziela poszczególne firmy, w przypadku podanego przykładu wyślemy dwa komunikaty, do dwóch różnych firm i różnych adresów URL * ciąg znaków ::: roziela ID firmy i URL

UWAGA! Bardzo ważne jest, aby ID firmy podać po lewej stronie od ciągu znaków :::

UWAGA! Jeśli podamy ID firmy inną niż firmy pryncypała, wysyłka komunikatu nastąpi tylko wtedy, gdy podana firma ma dostęp do transportu.

Przykład

  1. Ustawiamy setting API_MESSAGE_URL w sposób pokazany na obrazku: img.png
  2. Potwierdzamy etap i w logach aplikacji widzimy następujące informacje:
    2023-02-22 16:48:12.603 [nio-8080-exec-2] INFO  logintegra.integration.ApiService - W settingu API_MESSAGE_URL pryncypała Neuca znaleźliśmy specjalną notację, próbujemy wysłać komunikaty do kilku firm!
    2023-02-22 16:49:03.005 [nio-8080-exec-2] INFO  logintegra.integration.ApiService - Wysyłamy komunikat na adres http://localhost:8080/apollo/api/handleMessage podany dla firmy 114641061
    2023-02-22 16:49:09.730 [nio-8080-exec-2] INFO  logintegra.integration.ApiService - Wysyłamy komunikat na adres http://localhost:8080/apollo/api/handleMessage podany dla firmy 260899746
    

Ostatnia zmiana: 2023-02-22 · Dariusz
Zbudowano: 2026-11-20 10:32 UTC · wersja 1.0.0 · rewizja: 19fcdc12e