Integrace a API

Jaké integrace OptiRoutes nabízí?

Načítání objednávek ze souboru, FTP nebo SFTP

Nejjednodušší integrací je soubor, který váš systém už exportuje. Na obrazovce objednávek načte Načíst doručení soubor Excel nebo CSV; každé pole systému – adresu, jméno zákazníka, číslo objednávky, množství a další – jednou namapujete na název vašeho sloupce a každý další soubor se načte stejně. U souboru TXT s pevnou šířkou zadáte místo názvů sloupců pozice znaků. Řádky lze přeskočit podle značkovacího slova v poznámkách, druhé značkovací slovo může nahradit adresu a rozhodnete, zda se existující číslo objednávky aktualizuje, nebo přidá jako nové.

Chcete-li z procesu vyřadit lidskou práci, zvolte v nastavení metodu automatického načítání:

• Souborový server OptiRoutes – váš systém uloží denní soubor pojmenovaný podle data do složky vaší firmy na serveru FTP nebo na šifrovaném serveru SFTP.
• Váš vlastní server FTP – OptiRoutes se připojí s uživatelem, kterého mu zadáte, a načte soubor pojmenovaný dnešním datem nebo naposledy aktualizovaný soubor.
• Automatický import a export – objednávky se načtou samy a naplánují se i trasy, bez jediného kliknutí.
• Files API – váš software nahraje soubor objednávek přes HTTPS, jak je popsáno níže.

Na obrazovce zákazníků vytvoří nebo aktualizuje soubor Excel nebo CSV s číslem zákazníka, jménem, adresou, dobou zastávky a otevírací a zavírací dobou zákazníky a jejich časová okna.

Files API: objednávky dovnitř, POD a reporty ven

Každá firma v OptiRoutes má vlastní soukromou složku souborů: objednávky, které načítá, podepsané dodací listy s jejich fotografiemi a podpisy, exporty tras a reporty na konci dne. Files API umožňuje vašim systémům tuto složku přímo číst a zapisovat přes HTTPS, bez serveru FTP mezi tím. Manažer firmy přepíná mezi FTP a API v Nastavení → API a soubory a tam také vytváří klíče – není potřeba žádat podporu a nové firmy začínají na API.

Volání pokrývají ověření klíče, výpis složky, stažení, nahrání (až 50 MB na soubor) a smazání vámi nahraných souborů, výpis souborů POD za den podle objednávky a druhu a stažení všech souborů POD za den jako jednoho ZIP. Průvodce obsahuje ukázky kódu v Pythonu, C# a Node.js a skript PowerShell, který udržuje složku na vašem serveru synchronizovanou s firemní složkou – takže tým zvyklý na FTP může pracovat stejně jako dosud. Přečtěte si ho v průvodci Files API.

Jak jsou zabezpečeny klíče API?

• Nejnižší nutná oprávnění – každý klíč dostane jen oprávnění, která potřebuje: jen podepsané POD, čtení všech souborů, nebo nahrávání objednávek a souborů do inboxu.
• Povolené adresy – klíč lze omezit na pevné IP adresy vašeho serveru.
• Platnost a obměna – klíč může po určitém počtu dní vypršet; vytvořte nový klíč, přepněte a pak starý zrušte, bez výpadku.
• Okamžité zrušení – zrušený klíč přestane fungovat do 30 sekund.
• Audit – každé volání se zaznamená s časem, adresou, souborem a odpovědí a zobrazí se manažerovi.
• Bezpečné uložení – OptiRoutes uchovává jen otisk SHA-256 každého klíče; spojení probíhají přes HTTPS s TLS 1.2 nebo novějším a klíč má přístup jen do složky vlastní firmy.

Limity: 300 požadavků za minutu na klíč, 50 MB na soubor, 20 aktivních klíčů na firmu a až 5 000 položek v jednom výpisu složky.

API pro reporty a push

Pro reportovací nástroje a konektory ERP poskytuje samostatné API na adrese api-users.optiroutes.com data vaší firmy jako reporty a přijímá zaslaná data. Jedna adresa a jeden token, který OptiRoutes vydá pro vaši firmu, pokrývají každé volání. Na stránce dokumentace můžete vložit svůj token a zjistit, které reporty máte k dispozici a jaké je mapování sloupců vašeho účtu: přečtěte si dokumentaci API.

Dvě volání typu push fungují opačným směrem: zaslání objednávek zapíše soubor objednávek dne a spustí automatické načítání a zaslání řidičů, linek a vozidel nahradí celý vozový park, jako soubor vozového parku. Protože zaslaný seznam řidičů se počítá jako celý vozový park, posílejte vždy všechny řidiče, ne jen změny.

Export tras a webhooky

Export tras zapíše označené trasy ve formátu CSV, XLSX, XML, JSON nebo TXT s pevnou šířkou. Tabulka sloupců určuje, která pole odejdou a pod jakým záhlavím, lze přidat původní sloupce vašeho souboru objednávek a se správou položek uvede druhý soubor každou položku. Exporty mohou jít do vašeho počítače, na váš server FTP nebo do firemní složky a s formátem JSON lze export odeslat i na webovou adresu; pokud odeslání selže, systém to zkusí ještě jednou.

Pro každé doručení v okamžiku, kdy proběhne, vyplňte adresu pro reporty doručení v nastavení aplikace pro řidiče: každé hlášení o doručení, které řidiči vytvoří, se odešle i tam, takže se váš jiný systém aktualizuje sám.

E-mail, platby, mapy a zprávy

• E-mail – podepsané dodací listy odcházejí z vašeho vlastního účtu Gmail s heslem aplikace Google; reporty, jako je report palet na konci dne, chodí na váš e-mail pro reporty; platící zákazníci dostávají z pokladny potvrzení o platbě a řidiči potvrzení o odevzdání.
• Platby – dobití se platí na zabezpečené platební stránce Stripe, s volitelně uloženou kartou pro automatické dobíjení.
• Adresy a mapy – adresy se vybírají z návrhů Google a před plánováním se ověřují na mapě.
• Navigace – aplikace pro řidiče předá každou zastávku do Waze, na iPhonu do Apple Maps, podle adresy nebo přesných souřadnic.
• SMS a WhatsApp – zprávy o příjezdu a odkazy na sledování zákazníkům, upozornění manažerům, linky dodavatelům a obrázky tras řidičům přes WhatsApp.

Často kladené otázky