Przewodnik po API EasyCargo (część 3)
Ostatni artykuł z naszej serii o API EasyCargo zawiera kompleksowy, krok po kroku przewodnik do planowania załadunku przy użyciu API. Przeprowadzimy Cię przez cały proces od początkowej konfiguracji do uzyskania raportów planów załadunku, demonstrując interakcje API i ich odpowiednie reprezentacje w interfejsie EasyCargo. Ten przewodnik opiera się na fundamentalnych koncepcjach, jednocześnie wprowadzając zaawansowane funkcjonalności do optymalizacji operacji planowania wysyłki ładunków.
Zanim zagłębisz się w szczegóły implementacji, zbuduj solidne podstawy, korzystając z następujących dwóch niezbędnych zasobów. Nasz kompleksowy przewodnik teoretyczny po API obejmuje wszystkie podstawy, które musisz wiedzieć o API, podczas gdy nasz praktyczny przewodnik do zapytań API i testowania z ReqBin przeprowadzi Cię przez konfigurację klienta API, a także testowanie punktów końcowych. Razem, te artykuły ustanawiają niezbędne podwaliny i dostarczają kluczowy kontekst dla tematów omawianych w tym artykule.
Proces planowania załadunku krok po kroku
Aby korzystać z poniższych żądań API, będziesz musiał dołączyć token uwierzytelniający w nagłówku żądania. Szczegółowe procedury uwierzytelniania znajdziesz w naszym poprzednim artykule. Aby uzyskać token uwierzytelniający, musisz posiadać klucz API powiązany z Twoim kontem użytkownika. Skontaktuj się z naszym zespołem wsparcia, aby poprosić o klucz API. Pamiętaj, że tokeny uwierzytelniające są ważne tylko przez 1.5 godziny i wygasają później ze względów bezpieczeństwa.
Konfiguracja dostępu użytkownika
Pierwszym i jednym z najważniejszych kroków w naszym procesie planowania załadunku jest utworzenie konta, na przykład dla personelu magazynowego. Korzystając z endpointu /api/v1/users, możesz tworzyć nowe konta użytkowników z określonymi uprawnieniami. Musisz podać określone dane użytkownika, jak pokazano w poniższym żądaniu API. Panel EasyCargo natychmiast odzwierciedla to dodanie, potwierdzając dostęp użytkownika do konta firmowego. Ten usprawniony proces właściwie zapewnia zarówno zarządzanie dostępem, jak i kontrolę bezpieczeństwa dla operacji planowania załadunku, utrzymując jednocześnie wydajność operacyjną.
W poniższym fragmencie kodu wyślemy żądanie do endpointu /api/v1/users z treścią zawierającą szczegóły o użytkowniku, dla którego chcemy utworzyć konto. Chcemy określić imię, nazwisko, adres e-mail do logowania i rolę użytkownika. Rola użytkownika może być albo administratorem (reprezentowanym przez 1 w treści żądania), albo zwykłym użytkownikiem (reprezentowanym przez 2).
Definiowanie przestrzeni ładunkowych
Przed rozpoczęciem jakichkolwiek operacji planowania załadunku, zdefiniowanie przestrzeni ładunkowych jest niezbędne. Endpoint /api/v1/cargospaces umożliwia określenie wymiarów kontenera, w którym zostaną umieszczone przedmioty. Każda definicja przestrzeni ładunkowej wymaga ważnych specyfikacji, w tym długości, szerokości, wysokości i maksymalnej nośności. Obecnie API obsługuje tylko przestrzenie ładunkowe typu kontenerowego do tworzenia przez użytkownika, z potencjałem do obsługi innych typów przestrzeni ładunkowych w przyszłych aktualizacjach. System sprawdza wszystkie specyfikacje, aby upewnić się, że spełniają wymagania operacyjne i standardy bezpieczeństwa. Po zdefiniowaniu, przestrzeń ładunkowa pojawia się w interfejsie EasyCargo, potwierdzając pomyślne utworzenie i umożliwiając natychmiastowe użycie do planowania załadunku.
W poniższym fragmencie kodu wyślemy żądanie do endpointu /api/v1/cargospaces z treścią zawierającą szczegóły dotyczące kontenera, z celem utworzenia nowej przestrzeni ładunkowej. Określamy nazwę, szerokość, wysokość, długość i maksymalną wagę załadunku. Wskażemy również system miar używany do definiowania wartości (1 dla systemu metrycznego i 2 dla systemu imperialnego) oraz typ przestrzeni ładunkowej, który jest ustawiony na 1, reprezentujący kontener. Jak wspomniano wcześniej, tylko ten typ przestrzeni ładunkowej jest obsługiwany.
Zarządzanie towarami do załadunku
Po zdefiniowaniu przestrzeni ładunkowych, kolejnym krokiem jest utworzenie nowej przesyłki poprzez endpoint /api/v1/shipment-inputs. Proces ten obejmuje określenie zarówno szczegółów przesyłki, jak i poszczególnych przedmiotów do załadunku. Każdy przedmiot wymaga kompleksowych atrybutów, w tym dokładnych wymiarów, specyfikacji wagi, wymagań dotyczących obsługi i ograniczeń dotyczących układania. Interfejs EasyCargo zapewnia wizualne potwierdzenie pomyślnego utworzenia przesyłki, wyświetlając wszystkie przedmioty i ich specyfikacje. To szczegółowe wprowadzenie zapewnia dokładne planowanie załadunku i optymalne wykorzystanie przestrzeni w kolejnych krokach, przy jednoczesnym zachowaniu zgodności z przepisami bezpieczeństwa i protokołami obsługi.
W poniższym fragmencie kodu utworzymy nową przesyłkę z 82 sztukami jednego typu przedmiotu, używając endpointu /api/v1/shipment-inputs. W treści żądania określimy nazwę przesyłki, system miar i przechowywane przedmioty. Dla przedmiotów możemy określić ich szczegóły, takie jak wymiary i ograniczenia pakowania. W tym przykładzie zachowamy towary w grupie priorytetowej o nazwie Berlin, ponieważ tam chcemy dostarczyć lodówki. Pozwolimy im być obracalnymi i układalnymi podczas pakowania ich w przestrzeni ładunkowej. Pamiętaj, że obecnie nie jest możliwe wybranie koloru lub kontrolowanie, czy etykieta przedmiotu jest wyświetlana czy nie poprzez API.
Proces optymalizacji planu załadunku
Po ustaleniu szczegółów przesyłki, silnik optymalizacji EasyCargo przejmuje kontrolę, aby generować efektywne plany załadunku. Chociaż uruchamianie procesu optymalizacji bezpośrednio przez API jest obecnie w fazie rozwoju, użytkownicy mogą uzyskać dostęp do tej funkcjonalności poprzez interfejs EasyCargo, klikając przycisk Załaduj. EasyCargo uwzględnia wiele czynników, w tym rozkład wagi, sekwencję załadunku i wymagania dotyczące dostawy, aby stworzyć optymalne układy. Po wstępnej optymalizacji, użytkownicy zachowują elastyczność w dokonywaniu ręcznych korekt lub modyfikowaniu wyboru przestrzeni ładunkowej, zapewniając, że ostateczny plan spełnia określone wymagania operacyjne i ograniczenia, maksymalizując jednocześnie efektywność.
Generowanie raportów planu załadunku
Po sfinalizowaniu planu załadunku, kompleksowa dokumentacja staje się dostępna poprzez endpoint /api/v1/shipment-reports/{id}. Te szczegółowe raporty planu załadunku obejmują układy załadunku, wizualizacje 3D i precyzyjne instrukcje załadunku. Każdy raport dostarcza krytyczne metryki, w tym wykorzystanie przestrzeni, dane o rozkładzie wagi i szczegółowe wytyczne dotyczące obsługi dla personelu załadunkowego. System generuje zarówno interaktywne modele 3D, jak i możliwe do pobrania instrukcje PDF, zapewniając dostępność dla wszystkich zainteresowanych, takich jak pracownicy magazynu i Twoi klienci. Te raporty służą jako istotne odniesienia podczas fizycznego procesu załadunku, pomagając utrzymać spójność między planowanymi i rzeczywistymi układami załadunku. Sprawdź raport wysyłki, aby uzyskać pełne szczegóły.
W poniższym fragmencie kodu pobierzemy wszystkie szczegóły raportu przesyłki, używając endpointu /api/v1/shipment-report/{id}. Najpierw musimy uzyskać ID raportu przesyłki, wysyłając żądanie GET do /api/v1/shipments. Weź ID raportu przesyłki z tej odpowiedzi i dołącz go do ścieżki URL Twojego następnego żądania (/api/v1/shipment-report/{id}). Odpowiedź będzie zawierać wszystkie szczegóły, które widzisz na poniższym obrazku w raporcie PDF do wydruku.
Udostępnianie i współpraca
Ostatnia faza obejmuje dystrybucję informacji o planie załadunku do odpowiednich interesariuszy poprzez endpoint /api/v1/shipments. Ta funkcjonalność zapewnia dostęp do kompleksowych szczegółów przesyłki i powiązanych raportów, w tym interaktywnych reprezentacji 3D planu załadunku. Interesariusze mogą uzyskać dostęp do planu poprzez publiczny URL, umożliwiając wizualizację i weryfikację układu załadunku w czasie rzeczywistym. To podejście oparte na współpracy zapewnia, że wszyscy uczestnicy procesu załadunku mają natychmiastowy dostęp do niezbędnych informacji, ułatwiając efektywną koordynację i dokładną implementację planu załadunku. Możesz uzyskać dostęp do publicznego URL planu załadunku w EasyCargo, aby samemu zobaczyć rozmieszczenie towarów.
W poniższym fragmencie kodu pobierzemy wszystkie szczegóły dla naszej wcześniej utworzonej przesyłki, używając endpointu /api/v1/shipments/{id}. Aby uzyskać ID przesyłki, najpierw wyślij żądanie GET do /api/v1/shipments. Po zidentyfikowaniu ID przesyłki, wykonaj żądanie GET do /api/v1/shipments/{id}, aby otrzymać kompleksowe szczegóły przesyłki, w tym publiczny link, link do raportu przesyłki i inne informacje pokazane poniżej.
Podsumowując, wpływ API na branżę IT nie może być przeceniony – stały się one fundamentalnymi elementami nowoczesnej architektury oprogramowania i operacji biznesowych. API EasyCargo jest przykładem tego, jak dobrze zaprojektowane interfejsy mogą usprawnić złożone operacje logistyczne, zachowując jednocześnie precyzję i efektywność. Mamy nadzieję, że ta kompleksowa seria dostarczyła wartościowych informacji na temat korzystania z API EasyCargo dla Twoich potrzeb logistycznych. Niezależnie od tego, czy jesteś nowy w API, czy doświadczonym programistą, możliwości integracji są obszerne. Aby uzyskać spersonalizowaną konsultację dotyczącą implementacji EasyCargo w Twoich operacjach, skontaktuj się z nami poprzez nasz formularz kontaktowy. Nasz zespół jest gotowy pomóc Ci w poznaniu naszego rozwiązania, aby dopasować je do Twoich konkretnych wymagań.