API – Informacje ogólne

Comarch ERP XT API działa w oparciu o protokół HTTP i jego metody (GET, POST, PUT, DELETE) oraz zasoby, które odzwierciedlają poszczególne funkcjonalności serwisu. Autoryzacja realizowana jest w standardzie OAuth 2.0 (więcej o autoryzacji – kliknij tutaj).

Dostęp do API odbywa się poprzez połączenie HTTPS do serwera app.erpxt.pl. Dane są wysyłane i odbierane z serwera w formacie JSON.

Dostęp do API jest możliwy z poziomu Konta Użytkownika > Zarządzaj kontem > Publiczne API. Użytkownik, który jest administratorem w ramach konta Comarch ERP XT, wnioskuje o przydzielenie dostępu (opcja „Zapytaj o API”). Po jego uzyskaniu generuje z tego poziomu dane dostępowe oraz rejestruje aplikację korzystającą z API.

Wykorzystywane metody HTTP:

GET pobieranie danych dotyczących wszystkich lub wskazanych elementów/zasobów, w tym pobieranie wydruków
POST tworzenie nowego elementu/zasobu
PUT edycja istniejącego elementu/zasobu
DELETE usuwanie elementu/zasobu

Zasoby:

produkty https://app.erpxt.pl/api2/public/products
kontrahenci https://app.erpxt.pl/api2/public/customers
formy płatności https://app.erpxt.pl/api2/public/paymenttypes
rachunki bankowe https://app.erpxt.pl/api2/public/bankaccounts
faktury sprzedaży https://app.erpxt.pl/api2/public/invoices
faktury proforma https://app.erpxt.pl/api2/public/proformas
szablony wydruków https://app.erpxt.pl/api2/public/customprints

Każde żądanie do API zwraca status HTTP informujący o wyniku przetwarzania. Poniższa lista zawiera najczęściej używane statusy:

  • 200 OK – pomyślnie przesłano dane w metodzie GET, POST
  • 204 No Content – pomyślnie zakończono akcję w metodzie PUT, DELETE
  • 400 Bad Request – błąd w treści żądanie
  • 401 Unauthorized – brak autoryzacji
  • 403 Forbidden – dostęp zablokowany
  • 404 Not Found – nie znaleziono zasobu
  • 405 Method Not Allowed – nieobsługiwana metoda
  • 500 Internal Server Error – wewnętrzny błąd serwera

Operacje wykonywane poprzez API są zapisywane w historii zmian kontrahenta oraz dokumentu. W opisie operacji znajduje się informacja na temat nazwy aplikacji, poprzez którą dokonano zmian.

Wskazówka
Użytkownik Comarch ERP XT ma możliwość korzystania z API również w przypadku posiadania wersji testowej aplikacji (do momentu wystawienia 10 dokumentów handlowych).

Czy ten artykuł był pomocny?