Zlecenia serwisowe API

[Igor Bernakiewicz 345]

W ramach portalu dewelopera InsERT API zostało opublikowane API do zleceń serwisowych online.

API zleceń serwisowych online umożliwia dodanie nowych zgłoszeń oraz pobranie danych istniejących w bazie zleceń serwisowych.

API składa się z dwóch endpointów:

 

• Add service registration - za pomocą którego można dodać nowe zgłoszenie serwisowe.
• Get service order infromation - za pomocą którego można pobrać informacje o istniejącym zleceniu serwisowym

 

W odpowiedzi na poprawnie dodane zgłoszenie serwisowe zwracany jest identyfikator zgłoszenia serwisowego, który następnie można użyć do pobrania informacji o danym zgłoszeniu.

W Insert Nexo automatycznie generowane są linki do śledzenia konkretnego zgłoszenia.

Aby linki były generowane poprawnie konieczne jest zaznaczenie “Chcę korzystać z API i własnego formularza zleceń serwisowych” w parametrach zleceń serwisowych online, a następnie w polu “Użyj własnego adresu”, wstawienie własnego adresu na wzór: “https://mojezleceniaserwisowe.pl/”.

 

 

Do adresu doklejane będą identyfikatory konkretnych zgłoszeń (“https://mojezleceniaserwisowe.pl/glzwhYgTekCTG3RpkDdmHg”), a więc na podanej w parametrze zleceń serwisowych online stronie internetowej, powinny wyświetlać się informacje o danym zgłoszeniu pobrane za pomocą API z użyciem podanego identyfikatora.

 

Przykłady integracji
Zapraszamy do zapoznania się z przykładami integracji, które zostały opublikowane w serwisie GitHub.

[Radomił Ząbik 324]

A gdzie można znaleźć rozpiskę tych statusów - domyślam się, że zostanie opis zwrócony, ale pewnie nie uda się wycelować w wszystkie błędy

[Tomasz Kumiega 6]

W dniu 23.09.2022 o 10:36, Radomił Ząbik napisał:

A gdzie można znaleźć rozpiskę tych statusów - domyślam się, że zostanie opis zwrócony, ale pewnie nie uda się wycelować w wszystkie błędy

Jeśli chodzi o wszystkie błędy, jakie mogą wystąpić pod statusem BadRequest, to występują dwa. Jeden to błąd parsowania danych, który ma tytuł "Data parsing error." i oznacza, że API nie jest w stanie sparsować wysłanych danych (postaram się go dodać do przykładów w dokumentacji w najbliższym czasie). Drugi to błędy walidacji i tak jak widać na poniższym przykładzie, w odpowiedzi dostajemy wtedy informację o tym, jakie pola zostały niepoprawnie wypełnione oraz opis błędu. A jeśli chodzi o wszystkie możliwe statusy, jakie mogą wystąpić w odpowiedzi API, to są one opisane w dokumentacji. Innych statusów niż tych opisanych w dokumentacji nie przewidujemy, ale jeśli kiedykolwiek taki wystąpi, to prosimy o informację.
 

[Tomasz Kumiega 6]

Informujemy, że w związku z publikacją wersji 43 nexo, zaktualizowane zostało API zleceń serwisowych online.
 

Zmiany w API:

• Dodawanie nowego zgłoszenia - nie można dodać nowego zgłoszenia, jeżeli API nie zostało wcześniej aktywowane w Insert nexo lub formularz nie został wyłączony w parametrach zleceń serwisowych online.  
• Pobieranie danych zlecenia serwisowego - nie można pobrać danych zlecenia serwisowego, jeżeli API nie zostało wcześniej aktywowane w Insert nexo. 

    Do dokumentacji dodany został status 403 Forbidden, który jest zwracany w powyższych sytuacjach.

• Dokumentacja - Poprawiony błąd w przykładzie odpowiedzi 400 Bad Request. Poprawna nazwa klucza to "validationProblems", zamiast "validationErrors".

W parametrach zleceń serwisowych online dodane zostały osobne pola adresu formularza oraz historii zgłoszenia. Dzięki temu adresy formularza i historii zlecenia nie są już ze sobą ściśle powiązane. Oprócz dotychczasowego formatu adresu historii zlecenia (jak np. "www.zleceniaserwisowe.pl/historia-zlecenia/<idZlecenia>"), od teraz w url można wykorzystywać również parametry (np. "www.zleceniaserwisowe.pl/historia-zlecenia?id=<idZlecenia>"). 

[Krzysztof Gaiński 11]

Czy istnieje możliwość dodania opcji konfiguracji wielu adresów podstawowych? Właściwie to 'części wspólnej adresu'. Serwisujemy pod różnymi markami i na pewno by to ułatwiło.

[Arkadiusz Cieśla 201]

Dzień dobry, jeśli dobrze rozumiem to chce mieć Pan kilka różnych formularzy i ich używać pod różnymi adresami? W takim przypadku należałoby dodać do API możliwość sprecyzowania, z którego formularza zgłoszenie zostało dodane. Na ten moment nie mamy takich planów.

[Krzysztof Gaiński 11]

Dzień dobry,

 

dokładnie o coś takiego chodzi.

Dziękuję za informację.