Průvodce EasyCargo API (díl 3.)
Vítáme vás u posledního dílu naší minisérie o EasyCargo API! Dnes se ponoříme do samotného procesu plánování nakládky krok za krokem. Ukážeme vám, jak API zjednodušuje logistické operace – od nastavení uživatelského účtu, přes definování nákladových prostor, až po vygenerování tiskových reportů. Takže pokud chcete vědět, jak optimalizovat vaše procesy pomocí EasyCargo API, jste tu správně!
Než se pustíme do akce, doporučujeme si přečíst předchozí díly naší série:
- Teoretický průvodce API – všechny základy a pojmy, které byste měli znát
- Praktický průvodce API požadavky a testováním – jak nastavit API klienta a testovat endpointy s ReqBin
Pokud máte tyto základy v malíčku, můžeme pokračovat!
Proces plánování nakládky krok za krokem
Pro použití následujících API požadavků budete muset do hlavičky požadavku přidat autentizační token. Podrobné autentizační postupy najdete v našem předchozím článku. K získání autentizačního tokenu musíte mít API klíč spojený s vaším uživatelským účtem. Kontaktujte náš tým podpory, který vám klíč vygeneruje. Upozorňujeme, že autentizační tokeny jsou platné pouze 1,5 hodiny. Po uplynutí této doby jejich platnost vyprší a už vám nebudou fungovat.
Nastavení uživatelského přístupu
Prvním a jedním z nejdůležitějších kroků v našem procesu plánování nakládky je vytvoření účtu, například pro pracovníky skladu. Pomocí endpointu /api/v1/users vytvoříte nového uživatele s konkrétními oprávněními. Jak uvidíte níže v API požadavku, je potřeba poskytnout určité údaje o novém uživateli. Při správném provedení se nový uživatel ihned objeví v EasyCargu pod záložkou Uživatelé.
V kódu níže vidíte požadavek na /api/v1/users endpoint s tělem obsahujícím podrobnosti o uživateli, pro kterého chcete vytvořit účet. Je potřeba zadat jméno, příjmení, e-mailovou adresu pro přihlášení a typ uživatele. Typem uživatele může být buď administrátor (reprezentovaný číslicí 1 v těle požadavku) nebo běžný Uživatel (reprezentovaný číslicí 2).
Podívejte se na úplnou šablonu API požadavku: https://reqbin.com/duacb1ye
Definování nákladových prostor
Než začnete nakládat, musíte určit, kam se bude nakládat. Endpoint /api/v1/cargospaces vám umožní definovat různé typy kontejnerů. Každý prostor musí obsahovat délku, šířku, výšku a maximální zatížení. Zatím podporujeme pouze kontejnery, ale na dalších možnostech pracujeme! Po definování se kontejner zobrazí v rozhraní EasyCargo, což potvrzuje, že jste nikde neudělali chybu. Takto vytvořený kontejner můžete ihned použít pro plánování nakládky.
V kódu níže vidíte požadavek na /api/v1/cargospaces endpoint s tělem obsahujícím podrobnosti o kontejneru, který chcete vytvořit. Zadejte název, šířku, výšku, délku a maximální hmotnost. Dále vyberte měrnou soustavu (1 pro metrický systém a 2 pro imperiální systém) a typ nákladového prostoru. Ten je přednastaven na hodnotu 1, která představuje kontejner.
Podívejte se na úplnou šablonu API požadavku: https://reqbin.com/8ieqp8ey
Správa položek k nakládce
Jakmile máte definované nákladové prostory, je čas přidat jednotlivé položky. Pomocí endpointu /api/v1/shipment-inputs specifikujete rozměry, hmotnost a omezení každé položky. Rozhraní EasyCargo vám poté vizuálně potvrdí úspěšné vytvoření nakládky tím, že zobrazí všechny vložené položky a jejich specifikace.
V kódu níže vytvoříme novou zásilku s 82 kusy jednoho typu položky pomocí
/api/v1/shipment-inputs endpointu. V těle požadavku uvedeme název nakládky, měrnou soustavu a položky. U položek můžeme specifikovat rozměry a omezení. V tomto příkladu vytvoříme položky v prioritní skupině s názvem Berlín, protože právě sem chceme dodávat chladničky. Umožníme, aby se mohly libovolně otáčet a stohovat. Pro úplnost ještě zmíníme, že v současné době bohužel není možné přes API měnit barvu položek ani to, zda na boxech bude nebo nebude zobrazen název dané položky.
Podívejte se na úplnou šablonu API požadavku: https://reqbin.com/ozixloob
Generování optimálního plánu nakládky
Jakmile máme všechny podrobnosti o nakládce, můžeme přejít ke generování samotného nákladového plánu. Systém EasyCargo automaticky vypočítá nejefektivnější rozmístění nákladu s ohledem na rovnoměrné zatížení, pořadí nakládky a doručovací požadavky. Ačkoliv API zatím neumí optimalizaci provést samo, v aplikaci EasyCargo stačí kliknout na Naložit a systém za vás vše spočítá! Po prvotní optimalizaci máte možnost nakládku ručně upravit. Konečný plán tak bude splňovat všechny vaše specifické požadavky.
Tiskové reporty plánu nakládky
Po dokončení nakládky si můžete vygenerovat podrobný report s rozmístěním nákladu a 3D vizualizací. Endpoint /api/v1/shipment-reports/{id} poskytuje report ve formátu PDF pro jednoduché sdílení s kolegy a partnery. Podívejte se, jak report nakládky vypadá!
V kódu níže vidíte, jak získat všechny podrobnosti nakládky pomocí koncového bodu /api/v1/shipment-report/{id}. Nejprve musíme získat ID reportu odesláním požadavku GET do /api/v1/shipments. Z odpovědi potom vezmeme toto ID a zahrneme ho do URL dalšího požadavku (/api/v1/shipment-report/{id}). Odpověď bude obsahovat všechny podrobnosti, které vidíte na obrázku níže, ve formátu PDF k tisku.
Podívejte se na úplnou šablonu API požadavku: https://reqbin.com/ust8mrq2
Sdílení a spolupráce
Potřebujete sdílet plán nakládky s týmem nebo partnery? Endpoint /api/v1/shipments vám poskytne veškeré informace o nakládce, včetně interaktivního 3D zobrazení. Otevřete si veřejný odkaz nakládky v EasyCargu a prohlédněte si výsledné umístění položek.
V kódu níže načteme všechny podrobnosti o naší dříve vytvořené nakládce pomocí endpointu /api/v1/shipments/{id}. Chcete-li získat ID zásilky, nejprve odešlete požadavek GET na /api/v1/shipments. Jakmile identifikujete své ID nakládky, odešlete požadavek GET na /api/v1/shipments/{id}, abyste obdrželi úplné podrobnosti o nakládce, včetně veřejného odkazu, odkazu na tiskový report a dalších informací uvedených níže.
Podívejte se na úplnou šablonu API požadavku: https://reqbin.com/y5p3zysj
EasyCargo API je příkladem toho, jak dobře navržená rozhraní mohou zrychlit složité logistické operace. Umožňuje efektivně plánovat a spravovat nakládku prostřednictvím automatizace a inteligentních algoritmů. Díky snadné integraci můžete API využít k optimalizaci vašich logistických procesů a získat přehledné reporty pro snadnější plánování. Bez ohledu na to, zda s rozhraními API začínáte nebo jste zkušený vývojář, možnosti integrace jsou rozsáhlé. Pro osobní konzultaci o implementaci EasyCarga do vaší firmy nás kontaktujte. Společně najdeme to nejlepší řešení pro vás!