PRO Generowanie Artykułów API
Pomoc Systemu Produkcja
Autoryzacja do endpointów wymaga wygenerowania "Bearer tocken". Aby wygenerować token należy odpytać poniższy endpoint.
Uwaga! Nowo wygenerowany token jest ważny przez godzinę.
POST https://adres_serwera:port/auth
W Authorization wybieramy "Basic Auth" jako typ autoryzacji.
Username: Production.Extensions
Password: Należy zdefiniować w konfiguracji pliku Configuration.config w węźle ExtensionsPassword. Uwaga! Po dodaniu hasła należy zrestartować witrynę IIS.
W Body dodajemy wartość KEY: "grand_type" oraz VALUE: "client_credentials"
W odpowiedzi otrzymujemy "access_token", który należy przekazywać jako Bearer token do innych endpointów.
Przykład odpowiedzi z bramki w JSON:
Endpoint sprawdzający ceny netto/brutto, ceny netto/brutto z rabatem oraz walutę artykułów z szablonu.
POST https://adres_serwera:port/api/ExtensionsController/GetArticlePrice
W Authorization wybieramy "Bearer Token" jako typ autoryzacji, a następnie wpisujemy wcześniej wygenerowany token z value "access_token".
W Body przekazujemy parametry, które mają zostać sprawdzone pod względem cen.
Parametry:
Parametry ArticleParameters:
Jeżeli cena danego artykułu jest niezależna od parametrów to jedynymi wymaganymi parametrami jest "ContractorId" oraz " ArticleId". W przeciwnym wypadku w liście "ArticleParameters" należy przesłać nazwy parametrów, które wpływają na cenę razem z ich wartością. W zależności od typu parametru w szablonie może być podane wyłącznie "QuantityValue" lub "DicionaryValue" lub podane zarówno "QuantityValue" i "DicionaryValue" dla typu wyróżnik.
Uwaga! Parametry wpływające na cenę wymagają jawnego uzupełnienia. W module PRO Generowanie Artykułów API parametry wymagane nie muszą być jawnie uzupełniane. Wpisane parametry niespełniające warunków z szablonu w odpowiedzi otrzymają treść komunikatu błędu. Parametry które nie są jawnie wprowadzone, a są zależne od spełnienia warunku innego uzupełnionego parametru będą dodawane automatycznie zgodnie z ich formułą. Jeżeli nie uzupełniony parametr zależy od innego parametru nie spełnia warunków to w odpowiedzi otrzymamy treść komunikatu błędu. Szablon artykułu musi być aktywny w przeciwnym razie endpoint zwróci błąd lub jeżeli posiada więcej wersji zostanie użyta poprzednia aktywna wersja.
Przykładowe zapytanie w JSON:
Informacje zwracane przez bramkę:
Przykładowa odpowiedź z bramki w JSON:
Endpoint generujący zamówienie dla wybranego kontrahenta na artykuł z szablonu, posiadający uzupełnione parametry.
POST https://adres_serwera:port/api/ExtensionsController/CreateOrder
W Authorization wybieramy "Bearer Token" jako typ autoryzacji, a następnie wpisujemy wcześniej wygenerowany token z value "access_token".
W Body przekazujemy parametry, które mają być użyte do wygenerowania zamówienia.
Parametry:
Parametry Positions:
Parametry ArticleParameters:
Poprawne przetworzenie zapytania skutkuje utworzeniem zamówienia przez podanego użytkownika (UserId) na podanego kontrahenta (ContractorId). Na pozycjach zamówienia znajdują się nowo utworzone artykuły na podstawie wysłanych parametrów. W przypadku gdy parametr jest opcjonalny i jego wartość wyliczana jest za pomocą formuły, to jeżeli ma być aktywny wystarczy wysłać samą jego nazwę. Od strony Wapro Mag użytkownik może uzupełnić brakujące dane poprzez operację "2 PRO Poprawianie pozycji szablonu".
Na liście pozycji mogą znajdować się artykuły, których opcja obliczanie według cen Netto/Brutto na szablonach jest taka sama. Wynikiem będzie zamówienie o opcji obliczania według cen zgodnej z wybranym szablonem.
Uwaga! Parametry wpływające na cenę wymagają jawnego uzupełnienia. W module PRO Generowanie Artykułów API parametry wymagane nie muszą być jawnie uzupełniane. Wpisane parametry niespełniające warunków z szablonu w odpowiedzi otrzymają treść komunikatu błędu. Parametry które nie są jawnie wprowadzone, a są zależne od spełnienia warunku innego uzupełnionego parametru będą dodawane automatycznie zgodnie z ich formułą. Jeżeli nie uzupełniony parametr zależy od innego parametru nie spełnia warunków to w odpowiedzi otrzymamy treść komunikatu błędu. Stworzenie zamówienia z artykułem z szablonu powoduje przy poprawianiu szablonu podbicie wersji. Szablon artykułu musi być aktywny w przeciwnym razie endpoint zwróci błąd lub jeżeli posiada więcej wersji zostanie użyta poprzednia aktywna wersja.
Przykładowe zapytanie w JSON:
Informacje zwracane przez bramkę:
Przykładowa odpowiedź z bramki w JSON:
