Test API systemu księgowego — API

W panelu administracyjnym: API → Testowanie API systemu księgowego.

Co to jest

Piaskownica do integracji z Twoim systemem księgowym. Tutaj zebrane są wszystkie punkty, przez które nasz system sam komunikuje się z systemem księgowym: pyta o ceny, sprawdza dostępność na magazynie, ściąga powiązania materiał↔obrzeże itd. Na stronie widać, które endpointy masz skonfigurowane, a które nie; każdy można na żywo przetestować z prawdziwym zapytaniem i zobaczyć, co zwrócił system księgowy.

Co widzisz

Listę punktów wywołania systemu księgowego — karty o tej samej strukturze:

Nazwa i krótki opis punktu.
Co to daje — prostymi słowami: jaką funkcjonalność włącza konfiguracja tego endpointu.
Kroki konfiguracji — krótka instrukcja: o co poprosić Twojego programistę systemu księgowego, którego klucza parametru szukać w admince, gdzie wstawić URL.
Bieżący URL — jeśli już skonfigurowany. Pusto — oznacza, że endpoint nie działa.
Przycisk „Test" — przechodzi do zakładki z formularzem prawdziwego zapytania, pokazuje request/response.

Dostępne punkty integracji

Podstawowy zestaw (mogą być dodawane w miarę rozwoju systemu):

Pobieranie cen materiałów — nasz system pyta system księgowy o aktualne ceny materiałów płytowych. Bez tej konfiguracji ceny pobierane są z lokalnej bazy i mogą się różnić od systemu księgowego.
Pobieranie cen usług — to samo dla usług (obróbka, okucia).
Sprawdzenie dostępności na magazynie — przed uruchomieniem zamówienia w produkcję system pyta system księgowy, czy są wszystkie potrzebne materiały. Bez tego zamówienia mogą trafić do produkcji i wpaść z błędem „brak materiału".
Pobieranie obrzeża dla materiału — jakie obrzeże idzie w komplecie z konkretnym materiałem płytowym. Używane przy synchronizacji asortymentu; inaczej dopasowanie materiał→obrzeże trzeba konfigurować ręcznie.

Przy zapytaniu o ceny materiałów i usług platforma przekazuje do systemu księgowego rzeczywistego kontrahenta zamówienia — klient widzi swoje ceny umowne, a nie detaliczne. Jeśli kontrahent nie jest założony lub nie jest powiązany z systemem księgowym, kalkulacja nie zawodzi: zwracane są ceny detaliczne ze zrozumiałym wyjaśnieniem, co należy uzupełnić w danych. Naprawiono też przypadek, gdy użytkownik jednej firmy pracuje z katalogiem innej: zapytanie o ceny trafia teraz ściśle do systemu księgowego firmy, której katalog jest używany.

Jak skonfigurować

Ogólny przepis dla każdego punktu jest taki sam:

Poprosić Twojego programistę systemu księgowego o utworzenie usługi HTTP (endpoint) z wymaganym formatem zapytania/odpowiedzi. Opis formatu — wewnątrz karty na stronie testowania.
Pobrać od programisty URL tej usługi (powinien zaczynać się od https://; lokalny system księgowy może być na http://).
Wejść w Parametry → Parametry firmy, znaleźć parametr z kluczem podanym w karcie i wstawić URL.
Wrócić na stronę testowania i nacisnąć „Test" — od razu widać, czy system księgowy odpowiada, czy nie, i jakie dane zwraca.

Test zapytania

Na zakładce testu dla wybranego punktu widzisz:

Endpoint URL — dokąd poleci zapytanie.
Metodę HTTP (zwykle POST).
Nagłówki (w tym API-Key systemu księgowego jeśli ustawione).
Ciało zapytania — typowy przykład, który można od razu wysłać lub poprawić (np. podstawić prawdziwy code1c istniejącego towaru/zamówienia).
Przycisk „Wyślij" — daje surową odpowiedź od systemu księgowego: kod odpowiedzi, ciało, czas trwania.

Co jest ważne

Zapytania testowe są prawdziwe: rzeczywiście idą do Twojego systemu księgowego i mogą zmieniać jego dane (np. test „Przyjmij zamówienie" utworzy w systemie księgowym rekord). Bądź ostrożny na produkcji — najpierw testuj na staging-wersji systemu księgowego.
Wszystkie ustawienia punktów są przechowywane w parametrach produkcyjnych Twojej firmy — można je zmieniać bez redeployu.
W jednym z kluczy w systemie jest historyczna literówka („avilable" zamiast „available") — to nie błąd, pozostawione dla kompatybilności ze starymi instalacjami. Podpowiedź w karcie ostrzeże.
Dostęp — wszyscy administratorzy Twojej firmy.