Najczęściej zadawane pytania
Odpowiedzi na pytania o integrację z Comarch ERP Optima, Optima API, VerSync i model współpracy.
Ogólne
Comarch nie udostępnia publicznego REST API do Comarch ERP Optima. Oficjalne mechanizmy integracji to lokalny interfejs programu, Comarch ERP Optima webapi (SOAP/XML, nie REST) oraz bezpośredni dostęp do bazy SQL, który jest ryzykowny i niezalecany przy zapisie danych. Optima API od WebArm udostępnia REST API (HTTP/JSON) do pobierania, dodawania, aktualizacji i wyszukiwania danych: kontrahentów, towarów, dokumentów handlowych, faktur i dokumentów magazynowych. Więcej o przyczynach braku API →
Lokalny interfejs Optimy wymaga Windows, zainstalowanej Optimy na maszynie i środowiska .NET. Sesje są blokujące, a obsługa błędów bywa trudna w automatyzacji. Optima API daje prostszy kontrakt: wysyłasz żądanie HTTP z dowolnego systemu (Linux, macOS, Docker, aplikacja webowa), a serwer wykonuje operację po stronie Optimy. Odczyty są szybkie, a zapisy przechodzą przez walidację biznesową programu. Porównanie COM vs REST z przykładami kodu →
Tak. Optima API działa z Twoją istniejącą instalacją Comarch ERP Optima. Potrzebujesz aktywnej licencji Comarch na moduły, z których chcesz korzystać. Optima API to dodatkowa warstwa dostępu do danych, nie zamiennik licencji Comarch.
Samo uruchomienie Optima API na serwerze z Optimą trwa do 30 minut. Dodatkowym krokiem jest konfiguracja VPN, jeśli API ma być dostępne z zewnątrz. Po uruchomieniu zespół widzi Swagger UI z dokumentacją OpenAPI i może wysyłać pierwsze zapytania: pobieranie kontrahentów, towarów, dokumentów handlowych lub faktur. Dostępne są operacje batch do 100 rekordów w jednym żądaniu. Czas właściwej integracji zależy od zakresu: proste pobranie danych to kwestia godzin, a pełna automatyzacja procesów wymaga projektu wdrożeniowego. Praktyczny przewodnik po integracji sklepu →
Tak. WebArm wykonuje integracje Comarch ERP Optima i usługi wdrożeniowe dla systemów e-commerce, CRM, WMS, marketplace i aplikacji wewnętrznych. Typowy projekt łączy Optima API, czyli REST/JSON do Optimy, z VerSync, czyli silnikiem synchronizacji z retry, monitoringiem i rollbackiem. Najczęstszy zakres to produkty, stany magazynowe, cenniki, zamówienia, kontrahenci, faktury i statusy płatności.
Model opiera się na jednorazowej licencji + miesięcznej opłacie za utrzymanie. Licencja obejmuje instalację, konfigurację i szkolenie wstępne. Opłata miesięczna pokrywa aktualizacje kompatybilności z nowymi wersjami Optimy, wsparcie techniczne i monitoring. Szczegółowe ceny znajdziesz w cenniku na stronie głównej.
Optima API
Optima API to samodzielna aplikacja .NET z 976 endpointami w 131 kategoriach Swagger. Odczyty (GET i batch read) są szybkie, a operacje zapisu (POST, PUT, DELETE) przechodzą przez walidację biznesową programu: VAT, split payment, numerację i reguły cenowe. Kolejka operacji ogranicza konflikty współbieżności, a dokumentacja OpenAPI/Swagger jest dostępna od razu po instalacji. Porównanie architektur COM vs REST →
API pokrywa 100% modułów programu Comarch ERP Optima: Moduł Dostępowy (Kasa/Bank), Faktury, Handel z Magazynem (kontrahenci, towary z atrybutami i cennikami, stany magazynowe, dokumenty handlowe i dokumenty magazynowe), Detal, Rejestr VAT, Księga Podatkowa, Księga Handlowa, Środki Trwałe, Kadry i Płace, CRM. Łącznie 976 endpointów, 201 serwisów i 131 grup Swagger. Dostępne są operacje batch do 100 rekordów w jednym żądaniu, 25 endpointów batch oraz 9 dedykowanych endpointów synchronizacji z cursor-based polling dla stanów magazynowych i kontrahentów.
Optima API obsługuje dokumenty handlowe i magazynowe używane w Comarch ERP Optima: faktury sprzedaży, faktury zakupu, paragony, WZ, PZ, MM, RW, PW, dokumenty księgowe, rezerwacje oraz dokumenty powiązane. Metody API pozwalają dodawać, aktualizować, wyszukiwać, pobierać i eksportować dokumenty. Każda operacja uwzględnia walidację programu: VAT, split payment, numer obcy, jednostkę miary, datę kursu waluty, numerację i serie dokumentów.
Zdalne wystawienie faktury jest możliwe przez Optima API od WebArm. System zewnętrzny wysyła żądanie POST /api/dokumenty/faktury-sprzedazy/ z danymi kontrahenta, pozycjami, datami i płatnością, a Comarch ERP Optima nadaje numer faktury, liczy VAT i zapisuje dokument przez własną warstwę biznesową. Dzięki temu sklep, CRM, POS albo agent AI może tworzyć faktury bez pracy operatora w oknie Optimy.
API udostępnia endpointy do pobierania listy kontrahentów, towarów i cenników z paginacją oraz filtrami, np. po kodzie, nazwie, NIP, grupie lub dacie modyfikacji. Pobranie pojedynczego kontrahenta albo towaru zwraca komplet publicznych pól potrzebnych integracji: adresy, warunki płatności, ceny, atrybuty, jednostki miary i cenniki. Dodawanie kontrahentów, towarów i dokumentów przechodzi przez walidację biznesową Optimy.
Tak. API obejmuje moduły kadrowo-płacowe i księgowe Comarch ERP Optima. W Kadrach i Płacach dostępne jest pobieranie informacji o pracownikach, limitach urlopowych, nieobecnościach, szkoleniach, danych kadrowych i listach płac. W księgowości API obsługuje zapisy księgowe, rejestr VAT, księgę podatkową, księgę handlową i eksport dokumentów. Osobne endpointy obsługują środki trwałe: ewidencję, amortyzację i likwidację.
Comarch ERP Optima webapi to oficjalna warstwa SOAP/XML, wymagająca dodatkowej licencji i obejmująca wybrany zakres integracji. Optima API od WebArm udostępnia REST API (HTTP/JSON), łatwiejsze do podłączenia z aplikacji webowych, e-commerce, WMS, CRM i narzędzi AI. Dla nowych integracji REST zwykle skraca czas wdrożenia, bo nie wymaga generatorów SOAP ani osobnych klientów per język programowania. Jeśli Twój system już korzysta z SOAP, można utrzymać obecne podejście; jeśli budujesz nową integrację, REST jest prostszy operacyjnie.
API udostępnia 976 endpointów REST w 131 kategoriach Swagger. Obejmuje pobieranie, wyszukiwanie, dodawanie, aktualizację, usuwanie, operacje batch i synchronizację kursorową. Obsługiwane moduły Comarch ERP Optima to: Moduł Dostępowy (Kasa/Bank), Faktury, Handel z Magazynem, Detal, Rejestr VAT, Księga Podatkowa, Księga Handlowa, Środki Trwałe, Kadry i Płace oraz CRM.
Sama instalacja Optima API wymaga serwera Windows z zainstalowaną Comarch Optimą. To wymaganie Comarch, nie nasze. Natomiast systemy komunikujące się z API mogą działać na dowolnej platformie: Linux, macOS, kontenery Docker. To standardowe REST API dostępne przez HTTP/HTTPS.
Optima API ma kilka warstw ochrony przed zawieszeniem operacji: limit czasu wykonania, kontrolę pamięci, rate limiting, circuit breaker i kolejkę żądań. Jeśli operacja przekroczy bezpieczny czas lub system jest przeciążony, API odrzuca nowe żądania odpowiednim statusem zamiast doprowadzić do kaskadowej awarii. Dzięki temu integracja zachowuje przewidywalne zachowanie także przy trudniejszych operacjach.
Optima API wykorzystuje dwa nagłówki HTTP: X-Api-Key do autoryzacji oraz X-Optima-Firma do wskazania firmy skonfigurowanej po stronie API. Weryfikacja klucza odbywa się w czasie stałym, a rate limiting ogranicza liczbę żądań. Komunikacja wymaga HTTPS. Model API Key + Firma jest prostszy niż OAuth w integracjach serwer-serwer, a jednocześnie pozwala rozdzielić dostęp między klientami i bazami.
Tak. Nagłówek X-Optima-Firma wskazuje firmę skonfigurowaną po stronie API. Dzięki temu jeden serwer z Optima API może obsługiwać wiele baz Comarch Optimy. Każda firma pracuje w osobnym kontekście, co zapewnia izolację operacji między bazami.
VerSync
VerSync łączy Twój system (sklep internetowy, ERP, CRM) z Comarch ERP Optima. Obsługuje konektory REST API oraz MariaDB/MySQL jako źródła i cele danych. W konfiguracji YAML definiujesz źródło, cel, mapowanie pól, transformacje oraz klucz dopasowania rekordów. VerSync obsługuje walidację danych, błędy i automatyczne ponawianie operacji.
Najbezpieczniejszy model to Optima API dla zapisu kontrahenta oraz VerSync dla orkiestracji zmian. CRM, sklep lub panel B2B wysyła webhook albo rekord do kolejki, VerSync mapuje pola, sprawdza deduplikację po NIP lub e-mailu i wykonuje POST, PUT albo batch update przez Optima API. Każda operacja trafia do logów, więc wiadomo, który rekord został dodany, zmieniony albo odrzucony.
VerSync oferuje cztery tryby pracy. Init jednorazowo uzgadnia stan i wyrównuje różnice między systemami. Watch monitoruje zmiany z konfigurowalnym interwałem odpytywania. Rollback cofa zmiany z wybranego przedziału czasowego. Flaga --follow łączy init z automatycznym przejściem w watch. Każdy tryb można uruchomić z --dry-run (podgląd zmian bez zapisu) lub --record (test na pojedynczym rekordzie).
W konfiguracji VerSync definiujesz pipeline typu Watch na module stanów magazynowych. VerSync monitoruje zmiany z cursor-based polling, zapamiętuje pozycję ostatniego odczytu i pobiera tylko nowe zmiany. Interwał odpytywania jest konfigurowalny: od co minutę do raz dziennie, zależnie od potrzeb biznesowych. Batch processing z cooldown między partiami zapobiega przeciążeniu systemów źródłowych i docelowych. Szczegółowy przewodnik po synchronizacji stanów →
VerSync ma system outbox z trwałą kolejką. Retry z exponential backoff automatycznie ponawia nieudane operacje według skonfigurowanego interwału i limitu prób. Operacje, które wyczerpią limit, trafiają do dead-letter queue (DLQ) i nie blokują pozostałych rekordów. W planie Full dostępne są metryki Prometheus i dashboard Grafana z historią synchronizacji oraz alertami.
Tak, w planie Full. VerSync loguje każdą operację w apply journal ze stanem przed i po każdej zmianie. Rollback można wykonać na konkretny przedział czasowy, więc cofasz dokładnie te zmiany, które chcesz. Przed wykonaniem dostępny jest tryb dry-run: Admin API endpoint /rollback/plan generuje raport planowanych cofnięć bez ich realizacji. Dopiero po akceptacji planu wykonujesz właściwy rollback.
Każdy system, który udostępnia REST API lub dostęp do bazy danych, może być źródłem albo celem synchronizacji: sklep internetowy, marketplace, ERP, CRM, aplikacja wewnętrzna lub hurtownia danych. VerSync nie ogranicza się do konkretnych platform. Konfiguracja odbywa się przez pipeline YAML, w którym definiujesz źródło, cel i mapowanie pól. Przykład integracji sklepu krok po kroku →
Tak. VerSync ma dwa tryby testowe dostępne we wszystkich operacjach (init, watch, rollback). Flaga --dry-run generuje pełny raport zmian: co zostanie dodane, zmodyfikowane lub usunięte, bez zapisu danych. Flaga --record pozwala przetestować synchronizację na jednym konkretnym rekordzie identyfikowanym po match key. Oba tryby można łączyć, np. --dry-run --record pokazuje, co stałoby się z konkretnym rekordem bez wykonywania zmian.
Usługi
Zakres zależy od procesu. Jeżeli przepływ jest standardowy, można oprzeć go na VerSync i istniejących endpointach. Jeżeli proces jest specyficzny, projektujemy dodatek, program pomocniczy albo dedykowaną integrację. Zobacz zakres usług integracyjnych WebArm →
Wystarczy opis pracy: skąd przychodzą dane, kto je dziś przepisuje, które miejsca wymagają kontroli i jaki efekt ma być widoczny w Optimie. Techniczny dobór: Optima API, synchronizacja, importer, panel lub AI, robimy po analizie procesu.
Najczęściej są to: wymiana dokumentów z klientami, przygotowanie danych do księgowania, seryjne operacje na wielu bazach, powiadomienia o terminach, raporty dla klientów i listy wyjątków. Każdy projekt trzeba jednak sprawdzić pod kątem odpowiedzialności za dane, uprawnień i kontroli księgowej.
Tak, przez kontrolowaną warstwę dostępu i konkretny scenariusz. Agent AI może wyszukiwać dane, przygotowywać odpowiedzi, analizować należności albo porządkować dokumenty, a operacje księgowe powinny mieć reguły, uprawnienia i dziennik działań.
Prosta automatyzacja lub importer może zająć kilka dni. Integracja sklepu, CRM albo procesu biura rachunkowego zwykle wymaga analizy, mapowania i testu na danych, więc sensowny zakres startowy to jeden lub kilka tygodni. Orientacyjny koszt licencji i utrzymania opisuje cennik WebArm, a usługa wdrożeniowa jest wyceniana po zakresie.