WebAPI to usługa WWW udostępniająca funkcjonalności Symfonia ERP Handel. Umożliwia wymianę informacji pomiędzy modułem Symfonia ERP Handel, a rozwiązaniami zewnętrznymi (np. sklep internetowy). Zbudowana jest w oparciu o technologię web services oraz protokół REST.
Informacje o licencji są pobierane podczas uruchomienia WebAPI. W przypadku zmian w licencji, należy zatrzymać i ponownie uruchomić WebAPI, aby te informacje zostały zaktualizowane.
Skróty
WAH – (skrót od WebApi do Handlu) to przedrostek dla licencji WebAPI oraz przedrostek dla poszczególnych funkcjonalności objętych tą licencją.
WAF – (skrót od WebApi do FK) to przedrostek dla licencji WebAPI oraz przedrostek dla poszczególnych funkcjonalności objętych tą licencją.
WebAPI – to produkt, posiadający własny instalator.
Licencja WAH a OLE Automation
Od wersji 2019.1 uruchomienie Symfonia ERP Handel w trybie OLE Automation nie konsumuje licencji użytkownika programu Handel, ale licencję Web API (moduł Main). Zmiana ta ma na celu wyeliminowanie sytuacji, w których rozwiązania zewnętrzne, wykorzystujące tryb pracy w tle, nie działają poprawnie ze względu na w pełni wykorzystany limit użytkowników zalogowanych do aplikacji.
Działanie WebAPI
WebAPI to usługa systemu Windows. Usługa ta uruchamia w tle program Symfonia ERP Handel (korzystając z własnej licencji) i ‘serwuje’ jego funkcjonalność za pomocą protokołów https oraz REST. Zapytania (requesty) kierowane przez użytkowników do WebAPI są przekierowywane do modułu Handel, a odpowiedzi są zwracane użytkownikom/klientom usługi. WebAPI pracuje na konkretnym użytkowniku programu Handel.
Wielofirmowość
Pojęcie wielofirmowość używane bywa w dwóch znaczeniach:
•Jako możliwość pracy jednej instancji aplikacji z wieloma firmami jednocześnie. Jedna instancja WebAPI nie ma możliwości pracy z wieloma firmami jednocześnie. Aby pracować w dwoma firmami jednocześnie potrzebne są dwie instancje WebAPI itd. Każda instancja WebAPI pracuje bowiem w kontekście konkretnej Firmy.
•Jako możliwość pracy z różnymi firmami na tej samej licencji. WebAPI może korzystać z licencji wielofirmowej (umieszczonej w ‘bazie matce’). W takiej sytuacji zachowuje się dokładnie tak samo, jak inne moduły Symfonia ERP.
Webserwis podczas uruchomienia powołuje do życia minimum jedną instancję Handlu (może więcej) i loguje się tylko do jednej wybranej firmy wskazanej w danej konfiguracji. Aby skonfigurować pracę na wielu firmach po zainstalowaniu WebAPI należy minimum raz skopiować katalog z plikami WebAPI i w nowym katalogu dokonać konfiguracji dla innej/kolejnej firmy. Oczywiście powołanie do życia kolejnej instancji pracującej z inną firmą wymaga odpowiedniej licencji WAH. Należy również pamiętać, aby każdy webserwis miał inną nazwę, aby odpowiednio przedstawiał się w Usługach Windows (Windows Services).
Dlaczego WebAPI zużywa licencję nawet, jeśli nie ma aktualnie do niego zapytań?
Webserwis może działać 24h na dobę. Działa zawsze w kontekście danej firmy i konkretnego użytkownika a w tle uruchamia co najmniej jedną instancję Handlu. Uruchomienie instancji Handlu powoduje zużycie licencji WAH.
Dzięki temu serwis jest bardzo responsywny a odpowiedzi udzielane są w krótkim czasie (nie wymaga przełączania pomiędzy kontekstami, firmami, etc.).
Ilość potrzebnych stanowisk
Potrzebna jest jedna licencja WebAPI. W przypadku dużej ilości odpytań / dużych baz danych dokupienie dodatkowych licencji pozwala skalować rozwiązanie zrównoleglając operacje.
Sesja użytkownika w WebAPI
Sesja to identyfikowalne, zautoryzowane połączenie użytkownika z serwisem. Ilość sesji to ilość połączeń z WebSerwisem jakie w jednym czasie można nawiązać. Rozpoczynając sesję, blokujemy 1 licencję sesji aż sesja zakończy swoje życie. Ilość sesji jest zależna od licencji.
Dla sesji pamiętane są parametry połączenia. Sesja ma swój ‘czas życia’, który można skonfigurować. Z drugiej strony nawiązanie sesji zajmuje czas.
Domyślnie licencja pozwala na obsługę 10 jednocześnie otwartych sesji. W przypadku potrzeby większej ilości sesji, prosimy o kontakt.
Jaką licencję WebAPI wybrać?
Wybór licencji zależy od przeznaczenia na przykład:
•Jeżeli chcesz uruchamiać COM Handlu w trzeciej aplikacji (np. własnym serwisie) to wystarczy opcja podstawowa (funkcjonalność Main).
•Jeżeli chcesz skorzystać z udostępnionych modułów WebAPI, to wybierz potrzebne moduły (Towary, Kontrahencie, Zamówienia, Magazyn, Faktury sprzedaży).
•Jeżeli ilość modułów, z których chcesz korzystać, jest znaczna, to rozważ opcję zakupu wszystkich modułów w komplecie (ALL), gdyż może być tańsza.
•Jeżeli chcesz rozbudować WebApi o swoje moduły, potrzebny będzie pełen pakiet razem z funkcjonalnością WłasneModuły.
Przykładowo: Integracja z 5 sklepami internetowymi, gdzie każdy sklep nawiązuje jedno połączenie może wymagać:
•Opcja 1: WebApi 1 licencja (standardowo 10 sesji) z opcjami Towary, Kontrahenci, Zamówienia
•Opcja 2: WebApi 1 licencja (standardowo 10 sesji) z opcją full pakiet (i własnymi modułami) jeżeli planowana jest rozbudowa o integrację ze sklepami.
Kiedy są zużywane sesje i licencje WebAPI?
Licencje WebApi zużywane są do otworzenia równolegle połączenia do Handlu. W zależności od tego ile jest licencji WebApi, tyle można uruchomić pod spodem równolegle obiektów COM Handlu.
Licencja WebApi jest od razu zużywana przy starcie WebSerwisu, natomiast Licencja sesji jest zużywana przy połączeniu klienta do webserwisu.
Oferta
Funkcjonalność ta jest dostępna w subskrypcji rocznej i wyceniana w zależności od zakresu integracji.
Dostępne są następujące funkcje w licencji WAH:
Nazwa funkcjonalności |
Opis funkcjonalności |
Moduł – Main |
Funkcjonalność podstawowa WebAPI + działanie modułu HMF jako serwer OLE Automation. |
Moduł – Kontrahenci |
Pobieranie/edycja/tworzenie danych kontrahentów w module HMF. |
Moduł - Towary |
Pobieranie/edycja/tworzenie danych towarów w module HMF. |
Moduł - Stany magazynowe |
Pobieraniem danych o stanach magazynowych/handlowych towarów z modułu HMF. |
Moduł - Zamówienia obce |
Usługi biznesowe związane z pobieraniem/tworzeniem zamówień obcych, pobieraniem informacji dodatkowych do zamówień (w tym wydruków), wystawianie dokumentów powiązanych z zamówieniem (WZ, faktura). |
Moduł – Zamówienia własne |
Pobieranie/tworzenie zamówień własnych, pobieranie informacji dodatkowych do zamówień (w tym wydruków), wystawianie dokumentów powiązanych z zamówieniem (PZ, faktura zakupu). |
Moduł - Dokumenty sprzedaży |
Pobieranie, tworzenie dokumentów sprzedaży, korekt dokumentów sprzedaży oraz zaliczek pobieranie informacji dodatkowych do tych dokumentów, wydruki, wystawianie dokumentów powiązanych (WZ). |
Moduł – Dokumenty zakupu |
Pobieranie, tworzenie dokumentów zakupu oraz korekt dokumentów zakupu, pobieranie informacji dodatkowych do tych dokumentów, wydruki, wystawianie dokumentów powiązanych (PZ). |
Moduł - Dokumenty magazynowe |
Pobieranie, tworzenie dokumentów magazynowych, pobieranie informacji dodatkowych do tych dokumentów, wydruki, wystawianie dokumentów powiązanych. |
Moduł - Płatności |
Wprowadzanie dokumentów KP (kasa przyjmie), rozliczenie wskazanych faktur (o wprowadzonych kwotach) na wprowadzonym KP, pobieranie numeru wystawionego KP. |
Moduł - Rezerwacje |
Możliwość rezerwowania towaru oraz zdejmowania rezerwacji. |
Możliwości włączenia dodatkowego modułu – własnego |
Możliwość stworzenia własnych modułów udostępniających inne usługi biznesowe w formacie web service. |
Funkcjonalność Main + wszystkie powyższe funkcjonaności |
Komplet - wszystkie powyższe. |
Dostępne są następujące funkcje w licencji WAF:
Nazwa funkcjonalności |
Opis funkcjonalności |
Moduł – Main |
Funkcjonalność podstawowa WebAPI FK + działanie procesu ITG. |
Moduł – Kontrahenci |
Pobieranie/edycja/tworzenie danych kontrahentów w module FKF. |
Moduł – Pracownicy |
Pobieranie/edycja/tworzenie danych pracowników w module FKF. |
Moduł – Słowniki |
Pobieranie definicji słowników oraz ich elementów, możliwości dodawania i edycji elementów słowników. |
Moduł – Rozrachunki |
Pobieranie i filtrowanie rozrachunków za pomocą predefiniowanych filtrów, możliwość utworzenia własnych filtrów. |
Moduł – Wymiary |
Pobieranie klasyfikacji wymiarów oraz wymiarów dokumentów. |
Moduł – Dokumenty |
Możliwość dodawania do bufora dokumentu prostego, dokumentu zakupu, dokumentu sprzedaży oraz samodzielnie zdefiniowanego dokumentu. |
Moduł – Plan kont |
Pobranie planu kont w postaci drzewa oraz płaskiej listy. |
Nie ma możliwości zakupu pojedynczych funkcjonalności WebAPI (np. Towary czy Kontrahenci) bez zakupu licencji WebAPI Main.
Zobacz także: