Strona może być nieaktualna
Nikt jej nie zmieniał od 61 miesięcy (ostatni commit: 2021-10-14, Mateusz Sosnowski). Jeśli opisuje stan, którego już nie ma, zgłoś ją jako nieaktualną.
JSON REST API v1 - możliwości integracji¶
API wystawiane przez system Okien czasowych firmy Logintegra umożliwia wykonywanie podstawowych operacji przez systemy wewnętrzne kontrahentów. Wszystkie zapytania powinny być szyfrowane za pomocą protokołu HTTPS.
1. Struktura komunikatów¶
API budowane jest w sposób używający metod HTTP do rozpoznawania akcji, którą chcesz wykonać.
HTTP GET- pobieranie danychHTTP POST- autentykacja oraz zapisanie danychHTTP PUT- edycja istniejących danychHTTP DELETE- usuwanie danych
Każdy komunikat oprócz logowania wymaga podania tokenu autoryzacyjnego w nagłówku
węzła Authorization: Bearer access_token. Jeżeli komunikat przesyła dane, które powinny zostać zapisane w systemie
Okien czasowych dodatkowo w nagłówku konieczne jest przesłanie węzła Content-Type: application/json. Analiza
odpowiedzi powinna w pierwszej kolejności opierać się na kodach HTTP otrzymanych z systemu. Obsługiwane aktualnie kody
to:
200 OKW treści odpowiedzi znajdują się dane, o które pytałeś.201 CreatedUtworzono – wysłany dokument został zapisany na serwerze.400 Bad RequestNieprawidłowe zapytanie – żądanie nie może być obsłużone przez serwer z powodu nieprawidłowości postrzeganej jako błąd użytkownika (np. błędna składnia zapytania).401 UnauthorizedNieautoryzowany dostęp – żądanie zasobu, który wymaga uwierzytelniania.403 ForbiddenZabroniony – serwer zrozumiał zapytanie, lecz konfiguracja bezpieczeństwa zabrania mu zwrócić żądany zasób.404 Not FoundNie znaleziono – serwer nie odnalazł zasobu według podanego URL ani niczego co by wskazywało na istnienie takiego zasobu w przeszłości.422 Unprocessable EntityPrzesłano niepoprawne dane — serwer zrozumiał zapytanie, ale dane nie spełniają reguł walidacji.500 Internal Server ErrorWewnętrzny błąd serwera – serwer napotkał niespodziewane trudności, które uniemożliwiły zrealizowanie żądania.504 Gateway TimeoutPrzekroczony limit czasu — zapytanie wykonuje się zbyt długo.
Zawartość odpowiedzi jest przesyłana w formie pliku JSON zgodnego z formatem proponowanym przez Google w dokumencie https://google.github.io/styleguide/jsoncstyleguide.xml.
2. Autoryzacja¶
Uwaga: Do testów logowania można użyć loginu i hasła dowolnego użytkownika, jednak aby mieć dostęp do api, konieczne jest utworzenie użytkownika ze specjalną rolą. W tym celu należy skontaktować się z nami, pisząc na adres info@logintegra.com.
Logowanie do systemu odbywa się przez wysłanie dokumentu JSON o treści:
na adres
W przypadku niepowodzenia zostanie wysłany komunikat HTTP 401 Unauthorized.
Jeżeli dane logowanie będą poprawne, wysłany zostanie kod HTTP 200 OK oraz odpowiedź
{
"username": "user_name",
"roles": [],
"access_token": "tj0mljefgtscns82fhkj3v7ld27173281hc",
"token_type": "Bearer"
}
Najistotniejszym elementem odpowiedzi jest węzeł access_token, którego wartość będzie używana do autoryzacji podczas
przesyłania kolejnych zapytań. W nagłówku każdego kolejnego zapytania konieczne będzie przesyłanie
parametru Authorization: Bearer tj0mljefgtscns82fhkj3v7ld27173281hc. Bez tej informacji odpowiedzią będzie zawsze
komunikat HTTP 401 Unauthorized. Token jest ważny 24 godziny od wykonania ostatniego zapytania. W przypadku
wygaśnięcia tokenu konieczne będzie ponowne zalogowanie do systemu i zapisanie nowego tokenu.
Zapytaniem tym nie musi być logowanie, może to być wywołanie dowolnej funkcji systemu.
3. Dostępne operacje¶
Sprawdzenie, czy system jest dostępny¶
Zapytanie:
Możliwe odpowiedzi:
HTTP 200- Serwis działa poprawnieHTTP 500- Wewnętrzny błąd serweraHTTP 504- Zbyt duże obciążenieTime out- Serwis niedostępny
W przypadku poprawnego działania serwisu zwrócone zostaną także następujące informacje:
{
"status": "running",
"version": "2.38.1", //aktualna wersja aplikacji
"date": "2019-01-01T11:23:23Z" //aktualna data na serwerze
}
Zatwierdzenie zakończenia rozładunku¶
Dowolna z poniższych opcji:
HTTP PUT
https://apollo.logintegra.com/apollo/api/trasports/$transportId/confirm/END_OF_UNLOAD lub
https://apollo.logintegra.com/apollo/api/trasports/$erpIdentifier/confirm/END_OF_UNLOAD lub
https://apollo.logintegra.com/apollo/api/trasports/$altIdentifier/confirm/END_OF_UNLOAD
Content-Type: application/json
Authorization: Bearer access_token
APIVersion: v1
Jako data potwierdzenia statusu zostanie użyta aktualna data serwera. Jako osoba potwierdzająca statusy zostanie zapisany użytkownik, którego system klienta używa podczas autoryzacji.
Możliwe odpowiedzi¶
- W przypadku poprawnego potwierdzenia statusu otrzymamy komunikat:
HTTP 200 OK - W przypadku braku aktualnego tokenu otrzymamy komunikat:
HTTP 401 Unauthorized - W przypadku braku uprawnień otrzymamy komunikat:
403 Forbidden - W przypadku nieodnalezienia transportu o podanym identyfikatorze lub nieodnalezienia odpowiedniego statusu otrzymamy
komunikat:
HTTP 404 Not Found - W przypadku znalezienia więcej niż jednego transportu o podanym identyfikatorze otrzymamy
komunikat:
HTTP 422 Unprocessable Entity
Tworzenie zamówienia¶
HTTP POST
https://apollo.logintegra.com/apollo/api/orders/
Content-Type: application/json
Authorization: Bearer access_token
APIVersion: v1
Treść komunikatu powinna być zgodna ze wzorem z pliku neuca_order_no_log_operator.json5 jeżeli nie zdecydujemy się na
synchronizowanie danych o operatorach logistycznych odpowiedzialnych za załadunek lub z plik neuca_order.json5
jeżeli informacje o operatorach mają być przetwarzane.
Edycja zamówienia¶
HTTP PUT
https://apollo.logintegra.com/apollo/api/orders/$id lub
https://apollo.logintegra.com/apollo/api/orders/$erpIdentifier lub
https://apollo.logintegra.com/apollo/api/orders/$altIdentifier
Content-Type: application/json
Authorization: Bearer access_token
APIVersion: v1
Treść komunikatu powinna być zgodna ze wzorem z pliku neuca_order_no_log_operator.json5 jeżeli nie zdecydujemy się na
synchronizowanie danych o operatorach logistycznych odpowiedzialnych za załadunek lub z plik neuca_order.json5
jeżeli informacje o operatorach mają być przetwarzane.
Pobieranie informacji o transportach¶
Zgodnie z ustaleniami utworzenie nowego transportu lub edycja istniejącego transportu spowoduje wysłanie komunikatu o treści zgodnej ze wzorem z pliku neuca_transport na adres wskazany przez Klienta.
Ostatnia zmiana: 2021-10-14 · Mateusz Sosnowski
Zbudowano: 2026-11-20 10:32 UTC · wersja 1.0.0 · rewizja: 19fcdc12e