Qcadoo posiada API REST, dzięki któremu inne programy mogą się z nim integrować. Większość metod API powstało na potrzeby integracji z systemami ERP, dlatego też nie wszystkie funkcjonalności i dane mają odzwierciedlenie w API. Oczywiście w miarę potrzeb API jest rozbudowywane. Aby zintegrować się z Qcadoo potrzebny jest zdefiniowany użytkownik, który będzie należał do grupy posiadającej rolę systemową ROLE_API. Do autentykacji należy użyć loginu i hasła tak stworzonego użytkownika i wykorzystać metodę autentykacji Basic Auth. Poszczególne metody API wchodzą z różnych pluginów, które należy mieć włączone, aby móc używać tych metod. To w jakim pluginie znajduje się metoda API jest uzależnione od funkcjonalności, do której była potrzeba stworzenia API. Zarówno format żądań jak i odpowiedzi jest oparty o standard JSON. Oprócz poniższej dokumentacji Qcadoo posiada automatycznie wygenerowaną dokumentację wszystkich metod za pomocą Swagger.

Do testów API można wykorzystać dowolnego klienta REST np. Talend API Tester.

Przykładowy request
Przykładowy request
Przykładowy response
Przykładowy response

Proponowany przez nas proces integracji systemu zewnętrznego z qcadoo MES jest następujący:

  1. Na bieżąco do qcadoo wysyłane są dane podstawowe jak: produkty (API), jednostki (API), partie (API), czy firmy (API). Pozostałe dane, które możesz zintegrować znajdziesz w podrozdziale: Dane podstawowe.

  2. Cały proces zlecania produkcji możesz rozpocząć od przesłania do qcadoo zamówień sprzedaży z systemu ERP (API).

  3. Teraz rozpisz produkcję w qcadoo, tworząc zlecenia, plany i przekaż do realizacji. Innymi słowy wykorzystaj wszystkie funkcjonalności, które qcadoo oferuje.

  4. Do poprawnej realizacji procesu niezbędne będą dostępne surowce. Stan magazynowy musi znaleźć się w qcadoo. Dokumenty przychodowe PZ możesz przesłać do qcadoo (API). Możesz też przesłać dostawę, czyli zamówienie zakupu (API) i zrealizować ją w qcadoo. Efektem odbioru dostawy będzie dokument PZ. Jeśli potrzebujesz go w swoim ERP, możesz go z qcadoo pobrać (API).

  5. Efektem realizacji produkcji i akceptacji rekordów rejestracji są dokumenty RW i PW utworzone w qcadoo. I je również warto pobrać do ERP (API).

  6. Zakończeniem procesu produkcyjnego jest wydanie zamówionych wyrobów klientowi, za pomocą dokumentu WZ. Możesz go pobrać do ERP (API). Ale nie musisz - jeśli pobrałeś dokument PW w kroku poprzednim, to stan w ERP powinien być zapewniony i tam możesz zakończyć proces sprzedaży.

Obsługiwane przez qcadoo komunikaty API opisane są w podrozdziałach do tej strony oraz w rozdziale API-WMS.