Optima API: REST API do Comarch ERP Optima
Czysty JSON in/out. Każde wywołanie przechodzi walidację biznesową Optimy: VAT, split payment, numeracja i dokumenty powiązane.
Dodawanie, modyfikacja dokumentów i pobranie danych handlowych, magazynowych oraz księgowych. Tworzenie dokumentów powiązanych (np. WZ do faktury sprzedaży), zarządzanie kontrahentami, towarami, cennikami i stanami magazynowymi. Dwukierunkowa synchronizacja danych z platformami e‑commerce, systemami WMS i CRM.
Jeden POST zastępuje ręczne zapisanie dokumentu. Optima sprawdza VAT, split payment i numerację, zanim operacja trafi do danych firmy.
Handel, magazyn, księgowość, kadry, kasa/bank, CRM i środki trwałe. Od faktury sprzedaży po limity urlopowe pracownika, nieobecności i szkolenia w module kadrowo-płacowym.
Dane Optimy są dostępne przez REST, więc agent AI może analizować sprzedaż, generować raporty i uruchamiać procesy opisane w OpenAPI.
API ma kolejkę operacji, limity, watchdog i kontrolę pamięci. Instalujesz je jako Windows Service i dostajesz przewidywalną warstwę integracji.
Biuro rachunkowe z 20 klientami albo holding z 10 spółkami może pracować na jednej instancji API z izolacją danych per firma.
Import 100 faktur jednym żądaniem. Synchronizacja z kursorem pobiera tylko zmiany, zamiast za każdym razem czytać pełny snapshot danych.
GET, POST, PUT, DELETE i pełne CRUD na każdym module
Zakres od handlu i magazynu po kadry, płace oraz księgowość
Przejrzysta dokumentacja OpenAPI pogrupowana tematycznie
Automatyczna weryfikacja każdego endpointu przed release
Czym jest Optima API?
Optima API to gotowe REST API do Comarch ERP Optima, stworzone przez WebArm. Zamienia zamknięty system ERP w otwartą platformę integracyjną dostępną przez HTTP/JSON. Operacje zapisu przechodzą przez oficjalne mechanizmy Optimy, więc zachowują walidację VAT, split payment i numeracji dokumentów. API udostępnia 976 endpointów obejmujących wszystkie moduły Comarch ERP Optima: Moduł Dostępowy, Faktury, Handel, Detal, Księgę Podatkową, Księgę Handlową, Środki Trwałe, Kadry i Płace oraz CRM.
REST API vs natywny COM: porównanie
| Cecha | REST API (WebArm) | Natywny COM |
|---|---|---|
| Protokół | HTTP/JSON | COM/DCOM |
| Języki programowania | Dowolny (Python, PHP, JS, Java...) | C#, VB.NET |
| System klienta | Dowolny (Linux, macOS, Windows) | Tylko Windows |
| Dostęp zdalny | Tak (HTTPS) | Lokalnie lub DCOM |
| Sesje | Bezstanowe | Sesyjne (blokujące) |
| Operacje batch | Tak (np. 100 faktur jednym żądaniem) | Brak |
| Dokumentacja | Swagger / OpenAPI | Brak oficjalnej |
| Walidacja biznesowa | Pełna (przez COM) | Pełna |
REST API vs bezpośredni SQL: dlaczego nie pisać do bazy?
Niektóre integracje z Comarch Optima omijają API i piszą bezpośrednio do bazy SQL. To może wyglądać szybciej na starcie, ale pomija walidację biznesową Comarch. Optima API daje wygodę REST bez ryzyka ręcznego zapisu do struktury bazy.
| Cecha | REST API (WebArm) | Bezpośredni SQL |
|---|---|---|
| Walidacja VAT / split payment | Automatyczna (COM) | Brak, wymaga ręcznej implementacji |
| Numeracja dokumentów | Zgodna z definicjami Optimy | Ryzyko duplikatów i luk |
| Spójność danych | Gwarantowana przez Comarch | Ryzyko uszkodzenia bazy |
| Aktualizacje Optimy | API adaptuje się automatycznie | Schemat bazy się zmienia, integracja przestaje działać |
| Gwarancja Comarch | Zachowana | Utracona |
| Dokumenty powiązane | Automatyczne (np. WZ do FS) | Ręczna obsługa relacji w SQL |
Interaktywna dokumentacja OpenAPI, każdy endpoint gotowy do testowania
Bez web API, Comarch ERP Optima pozostaje trudna do podłączenia z zewnątrz. Z WebArm REST API aplikacja, agent AI lub platforma e‑commerce może bezpiecznie komunikować się z Optimą przez standardowe żądania HTTP.
- Operacje zapisu przechodzą przez oficjalne mechanizmy Optimy i zachowują spójność danych
- Zero bezpośrednich zapisów do SQL: integracja nie omija reguł biznesowych Optimy
- OpenAPI spec gotowa do podłączenia pod dowolny model AI
Comarch Optima API: do kogo i co pokrywa
Optima API zamienia Comarch ERP Optima w platformę integracyjną dostępną przez HTTP/JSON. Wysyłasz zwykłe żądanie, a walidacja biznesowa działa tak, jak przy ręcznej pracy w programie.
Potrzebujesz go, jeśli prowadzisz integrację ze sklepem e-commerce, magazynem WMS, bankiem, systemem obsługi kontrahenta, innym ERP w grupie kapitałowej albo agentem AI. Dodawanie dokumentów, pobieranie kontrahentów i wyszukiwanie dokumentów handlowych działa przez jeden interfejs, bez pisania tej samej logiki integracji po raz kolejny. Kontekst tego, dlaczego Comarch sam nie dostarcza REST API, opisujemy osobno.
Przez Optima API od WebArm realizujesz integracje z ERP w czterech trybach: dodawanie dokumentów, pobieranie danych dla sklepu, wyszukiwanie po numerze obcym lub dacie oraz synchronizacja kursorowa. Każdy tryb jest udokumentowany i testowany przeciwko kolejnym wersjom Comarch ERP Optima.
Dla kogo Optima API od WebArm
Dwukierunkowa synchronizacja zamówień, stanów magazynowych i cenników między e-commerce a Comarch ERP Optima. Dodawanie faktur sprzedaży, pobieranie listy zamówień i rezerwacja towaru.
Multi-firma z izolacją danych per klient lub spółka. Jedna instancja API może obsługiwać wiele baz, bez mieszania operacji między firmami.
Zobacz case studyMost między Comarch ERP Optima a systemami partnera, dostawcy lub hurtowni. Integrator dostaje stały kontrakt HTTP zamiast osobnej logiki dla każdego wdrożenia.
Pobieranie informacji z Optimy do hurtowni danych, modeli BI i agentów AI. OpenAPI opisuje endpointy w formacie czytelnym dla ludzi i narzędzi automatyzujących.
Firmy budujące własne aplikacje wokół Optimy dostają stabilny kontrakt API, przewidywalne wersjonowanie i zakres dopasowany do potrzeb konkretnego przedsiębiorstwa.
Co można zrobić przez Optima API od WebArm
API pokrywa 100% modułów Comarch ERP Optima: od faktury sprzedaży, przez kadry i płace, po księgowość. Operacje zapisu korzystają z tej samej logiki, co praca w oknie Optimy, więc numeracja, rejestr VAT, split payment i dokumenty powiązane są liczone przez program.
Dodawanie nowych faktur sprzedaży pojedynczo lub batch'em, pobieranie statusu, obsługę korekt i modyfikację dokumentów powiązanych, np. WZ do faktury sprzedaży. Endpointy odpowiadają poszczególnym rodzajom dokumentów, a zapis pilnuje numeracji, rejestru VAT i split payment. Wyszukujesz dokumenty po numerze obcym, dacie, kontrahencie i statusie płatności. Jednostka miary, stawka VAT oraz data kursu waluty są weryfikowane w momencie zapisu, tak jak przy pracy w Comarch ERP Optima.
Dokumentacja faktur sprzedażyObsługa dokumentów magazynowych (PW, RW, MM, WZ, PZ) z walidacją dostępności towaru, rezerwacji i partii. Ruchy magazynowe, eksport dokumentów i przyjęcia z kolektorów danych możesz połączyć z WMS oraz systemami obiegu dokumentów.
Dokumentacja towarówDodawanie kontrahentów, aktualizacja NIP, warunków płatności i grup cenowych. Pobieranie listy kontrahentów po segmencie, statusie lub atrybucie. Zmiana cennika jednym żądaniem dla kilkudziesięciu towarów i wariantów.
Dokumentacja kontrahentówPobieranie informacji o pracownikach, umowach, wypłatach, limitach urlopowych pracownika i ewidencji czasu pracy. Dodawanie nieobecności, urlopów, szkoleń BHP i delegacji. Procesy kadrowo-płacowe możesz połączyć z systemami rekrutacyjnymi lub benefitowymi bez duplikowania kartotek.
Dodawanie dokumentów księgowych, zapisów w rejestrze VAT i amortyzacji środków trwałych. Pobieranie sald kont, zestawień obrotów i JPK. Integracja może obsłużyć dekretację zamówień z e-commerce, import wyciągów bankowych i rozliczenia kasowe bez ręcznego przepisywania dokumentów.
Integracje z programem Comarch ERP Optima przez web API
Jedna warstwa API obsługuje systemy zewnętrzne, które muszą wymieniać dane z Optimą. Zamiast łączyć osobno sklep, magazyn i system obsługi klienta, używasz tego samego modelu żądań, walidacji, paginacji i błędów.
Automatyczna synchronizacja stanów magazynowych i cenników między Optimą a sklepami e-commerce. Optima API oferuje automatyzację integracji: pobieranie zamówień, zakładanie dokumentów w Optimie i rezerwację towaru. Synchronizacja z kursorem pobiera tylko zmiany od ostatniego odczytu.
Integracje z systemami WMS działają na tych samych zasadach, co e-commerce: dodawanie dokumentów magazynowych, pobieranie stanów i rezerwacji, potwierdzanie ruchów towaru oraz aktualizacja dokumentów wystawionych w magazynie.
Wiele grup firm używa Comarch ERP Optima w mniejszych spółkach, a programem ERP jakim jest Comarch ERP XL zarządza spółka matka. Warstwa integracji pozwala skonsolidować rozliczenia, faktury i rejestr VAT bez ręcznego przenoszenia dokumentów między aplikacjami.
Skala, wyszukiwanie dokumentów i agenci AI
Wolumen, filtry po numerze obcym i kontrahencie oraz OpenAPI gotowe pod modele językowe w jednym interfejsie.
Integracje często blokuje wolumen. 100 faktur importowanych pojedynczo to 100 transakcji i 100 kolejek. Tryb batch pozwala dodać 100 dokumentów jednym żądaniem, z wynikiem per dokument i walidacją każdego zapisu.
Wyszukiwanie po numerze obcym, kontrahencie, dacie wystawienia i statusie płatności. Pobieranie kontrahentów po atrybucie, grupie cenowej lub dacie ostatniej zmiany. Stany magazynowe w konkretnej lokalizacji dostępne są przez HTTP, bez znajomości struktury bazy danych.
Specyfikacja OpenAPI opisuje endpointy w formacie czytelnym dla modeli językowych. Agent podpięty do Comarch ERP Optima może analizować sprzedaż, wyszukiwać dokumenty, sugerować działania windykacyjne i generować raporty dla konkretnej firmy.
Dlaczego web API, a nie bezpośredni dostęp do bazy danych
Kuszącą alternatywą dla integracji jest bezpośredni zapis do bazy danych SQL Server, na której działa Comarch ERP Optima. Jest szybki w pierwszym wdrożeniu, ale omija walidację biznesową, numerację i logikę split payment. Każda aktualizacja programu może zmienić strukturę danych i zatrzymać integrację z dnia na dzień.
Optima API łączy natywne mechanizmy udostępniane przez program z wygodą HTTP. Aktualizacje kompatybilności są po naszej stronie, a integracja nie zapisuje dokumentów z pominięciem reguł Optimy. Porównanie obu podejść znajdziesz w artykule REST API vs natywne mechanizmy Comarch.
Ułatwienia pracy w web API dla integratorów
Oprócz operacji CRUD dostajesz mechanizmy, które skracają wdrożenie i zmniejszają liczbę błędów w produkcji.
Idempotentne żądania, paginacja, filtry, sortowanie i synchronizacja kursorowa. Do tego spójny format tworzenia komunikatów, błędy czytelne dla integratora i automatyczne ponowienia dla operacji batch.
Webhooki na zmiany ważnych dokumentów, własne rozszerzenia bez modyfikowania Optimy oraz nowe endpointy dodawane w ramach kontraktu serwisowego. Celem jest zwiększenie efektywności operacyjnej bez dokładania ręcznej pracy w programie.
E-commerce, system obsługi klienta, BI i agenci AI korzystają z tego samego interfejsu. Nie trzeba budować osobnej warstwy integracji dla sprzedaży, magazynu i sklepu.
Od czego zacząć integrację z programem Comarch ERP Optima
Sklep, WMS, system obsługi kontrahenta, ERP partnera albo agent AI: każdy scenariusz zaczyna się od dokumentacji encji. Każda encja ma przykłady JSON, typowe pułapki i scenariusz wdrożeniowy.
Encje Comarch Optima przez REST API
Szczegółowa dokumentacja per encja: endpointy, pola DTO, przykłady JSON i pułapki wdrożeniowe. Tego nie ma w oficjalnej dokumentacji Comarcha.
Przeglądaj encjeLicencja jednorazowa + serwis kompatybilności
Kupujesz raz. Comarch aktualizuje Optimę, a my utrzymujemy kompatybilność integracji.
Zobacz cennikPytania o Optima API
Architektura, zakres modułów, instalacja, kompatybilność z Comarch.
Lokalna integracja z Optimą wymaga Windows, .NET Framework i środowiska uruchomionego obok programu. Optima API udostępnia operacje przez REST/HTTP/JSON, więc Twój kod może działać na Linuxie, w Dockerze, w chmurze lub jako agent AI. Po stronie serwera API zarządza sesjami, kolejką operacji i obsługą błędów; Ty wysyłasz zwykłe żądanie HTTP.
Optima API obsługuje wszystkie 9 modułów licencyjnych Comarch ERP Optima: Moduł Dostępowy (Kasa/Bank), Faktury, Handel, Detal, Księgę Podatkową, Księgę Handlową, Środki Trwałe, Kadry i Płace oraz CRM. Łącznie daje to 976 endpointów REST w 131 kategoriach Swagger. Zewnętrzne aplikacje Comarch, takie jak BPM/DMS czy Business Intelligence, nie są częścią tego zakresu.
Sama instalacja na serwerze z Optimą trwa do 30 minut: kopiowanie plików, uruchomienie usługi i weryfikacja Swagger UI. Jeśli API ma być dostępne z zewnątrz, np. dla sklepu w innej lokalizacji, dochodzi konfiguracja VPN. Po uruchomieniu zespół widzi dokumentację OpenAPI i może wysyłać pierwsze żądania bez generowania klienta SOAP.
Każda nowa wersja Comarch ERP Optima może zmienić zachowanie mechanizmów integracyjnych, dlatego Optima API ma serwis kompatybilności. Klient z aktywnym serwisem otrzymuje aktualizację bez dodatkowej opłaty. Bez serwisu zachowujesz ostatnią działającą wersję dla swojej Optimy, a aktualizację możesz wykonać po wznowieniu serwisu lub jednorazowo.
Porozmawiajmy o Twojej integracji
Odpowiadamy w ciągu 24h w dni robocze.
Odpowiemy w ciągu 24h w dni robocze.
Telefon
+48 602 537 784Versanis Robert Mońka
woj. łódzkie, Polska
NIP: PL5732233120