WebArm ERP API dodaje interfejs HTTP/JSON do Comarch ERP Optima. Wysyłasz JSON, dostajesz JSON, a zapisy przechodzą przez walidację biznesową Optimy: VAT, split payment, numerację i dokumenty powiązane.
POST https://erp.twoja-firma.pl/api/dokumenty/faktury-sprzedazy
Content-Type: application/json
X-Api-Key: Rk7pN2x+mW5fLj/bV9gYtE=...
X-Optima-Firma: LOGIMED
{
"kontrahentKod": "LOGIMED",
"pozycje": [{
"towarKod": "USŁUGA-WDROŻENIE",
"ilosc": 1
}]
}
→ 201 Created
{
"id": 1847,
"numer": "FA/42/2026",
"kontrahentNazwa": "Logimed Sp. z o.o.",
"wartoscNetto": 5000,
"wartoscBrutto": 6150,
"vat": 1150,
"waluta": "PLN",
"pozycje": [{ ... }],
...
}WebArm ERP API jest niezależnym produktem WebArm. Nie jest produktem Comarch S.A. i nie jest przez Comarch S.A. sponsorowany, certyfikowany ani rekomendowany.
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 Swagger/OpenAPI pogrupowana tematycznie
Automatyczna weryfikacja każdego endpointu przed release
Po uruchomieniu WebArm ERP API zespół techniczny dostaje widok endpointów, parametrów i komunikatów HTTP/JSON. To praktyczny punkt wejścia do testowania integracji z Optimą.
Swagger pomaga szybko sprawdzić format żądań, przetestować operację i udostępnić opis API aplikacji, automatyzacji albo agentowi AI.
Dokumentacja API
Endpointy dokumentów i komunikaty HTTP/JSON
WebArm ERP API to gotowe REST API do Comarch ERP Optima tworzone przez WebArm jako niezależna warstwa integracyjna. Oprogramowanie dodaje interfejs HTTP/JSON do instalacji klienta, a operacje zapisu korzystają z natywnych mechanizmów programu, więc zachowują walidację VAT, split payment i numeracji dokumentów. Klient musi posiadać własną aktywną licencję Comarch ERP Optima oraz moduły wymagane przez dany proces.
| 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 |
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. WebArm ERP 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 |
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.
WebArm ERP 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 WebArm ERP 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.
Jeśli proces kończy się fakturą ustrukturyzowaną, API jest tylko częścią układanki. Do wysyłki faktur sprzedaży, odbioru faktur zakupowych, numeru KSeF i UPO służy osobny panel WebArm KSeF.
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.
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.
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. WebArm ERP 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.
Grupy firm często pracują na kilku bazach Optimy i systemach pomocniczych. Warstwa integracji pozwala skonsolidować rozliczenia, faktury i rejestr VAT bez ręcznego przenoszenia dokumentów między aplikacjami.
WebArm ERP API jest warstwą operacji w Comarch ERP Optima. KSeF obsługuje faktury ustrukturyzowane, numer KSeF i UPO. VerSync utrzymuje stałą synchronizację, kolejki i ponowienia tam, gdzie proces działa cały dzień.
WebArm ERP API dodaje albo aktualizuje fakturę sprzedaży w Optimie, pilnując numeracji, kontrahenta, płatności i rejestru VAT. WebArm KSeF przejmuje drugi etap: wysyłkę faktury do Krajowego Systemu e-Faktur, numer KSeF, status i UPO zapisane przy dokumencie.
Jeśli sklep, B2B albo magazyn mają działać stale, sama operacja REST nie wystarcza. VerSync utrzymuje kolejki, kursory zmian, ponowienia i monitoring, a WebArm ERP API pozostaje warstwą zapisu oraz odczytu danych z programu.
W licencji biura rachunkowego najważniejsza jest separacja kontekstu firmy. Integracja musi wiedzieć, z którą bazą Optimy i którym NIP-em pracuje, zanim pokaże dokumenty, wykona synchronizację albo wyśle faktury do KSeF.
Gdy trzeba połączyć WebArm ERP API, KSeF, importy CSV, hurtownię danych albo kilka systemów po stronie klienta, zaczynamy od mapy procesu. Dopiero potem dobieramy endpointy, harmonogram, retry i widoczność błędów.
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.
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ń.
WebArm ERP 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.
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.
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.
Szczegółowa dokumentacja per encja: endpointy, pola DTO, przykłady JSON i pułapki wdrożeniowe dla zespołów integrujących systemy biznesowe.
Przeglądaj encjeKupujesz raz. Gdy zmienia się system ERP, utrzymujemy kompatybilność warstwy integracyjnej.
Architektura, wymagania licencyjne, instalacja i kompatybilność.
Lokalna integracja z programem ERP wymaga Windows, .NET Framework i środowiska uruchomionego obok programu. WebArm ERP 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.
Klient musi posiadać własną, aktywną licencję Comarch ERP Optima oraz moduły wymagane przez dany proces. Dla typowych operacji dokumentów handlowych potrzebne są w szczególności Moduł Dostępowy oraz Handel/Faktury. WebArm nie sprzedaje i nie zastępuje licencji Comarch; dostarcza niezależną warstwę integracyjną działającą przy legalnej instalacji klienta.
Sama instalacja na serwerze klienta 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.
Nowa wersja Comarch ERP Optima może zmienić zachowanie mechanizmów integracyjnych, dlatego WebArm ERP 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 instalacji, a aktualizację możesz wykonać po wznowieniu serwisu lub jednorazowo.
Odpowiadamy w ciągu 24h w dni robocze.
Odpowiemy w ciągu 24h w dni robocze.
Telefon
+48 602 537 784Versanis Robert Mońka
NIP: PL5732233120