Integrácie a API

Aké integrácie OptiRoutes ponúka?

Načítanie objednávok zo súboru, FTP alebo SFTP

Najjednoduchšou integráciou je súbor, ktorý váš systém už exportuje. Na obrazovke objednávok Načítať dodávky prečíta súbor Excel alebo CSV; každé pole systému – adresu, meno zákazníka, číslo objednávky, množstvo a podobne – raz priradíte k názvu vášho stĺpca a každý ďalší súbor sa načíta rovnako. Pri súbore TXT s pevnou šírkou zadáte namiesto názvov stĺpcov pozície znakov. Riadky sa dajú preskočiť podľa značkového slova v poznámkach, druhá značka môže nahradiť adresu a rozhodnete, či sa existujúce číslo objednávky aktualizuje, alebo pridá ako nové.

Ak chcete ľudí z procesu úplne vynechať, zvoľte v nastaveniach spôsob automatického načítania:

• Súborový server OptiRoutes – váš systém uloží denný súbor pomenovaný podľa dátumu do priečinka vašej spoločnosti na FTP serveri alebo na šifrovanom SFTP serveri.
• Váš vlastný FTP server – OptiRoutes sa pripojí s používateľom, ktorého mu zadáte, a načíta súbor pomenovaný dnešným dátumom alebo naposledy aktualizovaný súbor.
• Automatický import a export – objednávky sa načítajú samy a naplánujú sa aj trasy, bez jediného kliknutia.
• API pre súbory – váš softvér nahrá súbor objednávok cez HTTPS, ako je opísané nižšie.

Na obrazovke zákazníkov súbor Excel alebo CSV s číslom zákazníka, názvom, adresou, časom zastávky a časmi otvorenia a zatvorenia vytvorí alebo aktualizuje zákazníkov a ich časové okná.

API pre súbory: objednávky dnu, POD a zostavy von

Každá spoločnosť v OptiRoutes má vlastný súkromný priečinok so súbormi: objednávky, ktoré načítava, podpísané dodacie listy s fotografiami a podpismi, exporty trás a zostavy na konci dňa. API pre súbory umožňuje vašim systémom čítať a zapisovať do tohto priečinka priamo cez HTTPS, bez FTP servera medzi tým. Manažér spoločnosti prepína medzi FTP a API v Nastavenia → API a súbory a tam aj vytvára kľúče – netreba žiadať podporu a nové spoločnosti začínajú na API.

Volania pokrývajú overenie kľúča, výpis priečinka, sťahovanie, nahrávanie (do 50 MB na súbor) a mazanie vami nahraných súborov, výpis súborov POD za deň podľa objednávky a druhu a stiahnutie všetkých súborov POD za deň ako jeden ZIP. Príručka obsahuje ukážky kódu v jazykoch Python, C# a Node.js a skript PowerShell, ktorý udržiava priečinok na vašom serveri synchronizovaný s priečinkom spoločnosti – takže tím zvyknutý na FTP môže pracovať rovnako ako doteraz. Prečítajte si ju v príručke k API pre súbory.

Ako sú zabezpečené kľúče API?

• Minimálne oprávnenia – každý kľúč dostane len oprávnenia, ktoré potrebuje: len podpísané POD, čítanie všetkých súborov alebo nahrávanie objednávok a súborov do inboxu.
• Povolené adresy – kľúč sa dá obmedziť na pevné IP adresy vášho servera.
• Platnosť a rotácia – kľúč môže po určitom počte dní vypršať; vytvorte nový kľúč, prepnite naň a potom starý zrušte bez výpadku.
• Okamžité zrušenie – zrušený kľúč prestane fungovať do 30 sekúnd.
• Audit – každé volanie sa zaznamenáva s časom, adresou, súborom a odpoveďou a zobrazuje sa manažérovi.
• Bezpečné uloženie – OptiRoutes uchováva z každého kľúča len odtlačok SHA-256; spojenia sú cez HTTPS s TLS 1.2 alebo novším a kľúč má prístup len k priečinku vlastnej spoločnosti.

Limity: 300 požiadaviek za minútu na kľúč, 50 MB na súbor, 20 aktívnych kľúčov na spoločnosť a až 5 000 položiek v jednom výpise priečinka.

API pre zostavy a push

Pre nástroje na zostavy a konektory ERP poskytuje samostatné API na adrese api-users.optiroutes.com dáta vašej spoločnosti vo forme zostáv a prijíma odosielané (push) dáta. Jedna adresa a jeden token, ktorý vydá OptiRoutes pre vašu spoločnosť, pokrývajú všetky volania. Na stránke dokumentácie môžete vložiť svoj token a pozrieť si, ktoré zostavy máte k dispozícii a aké je priradenie stĺpcov vo vašom účte: prečítajte si dokumentáciu API.

Dve volania typu push fungujú opačným smerom: odoslanie objednávok zapíše súbor objednávok na daný deň a spustí automatické načítanie a odoslanie vodičov, liniek a vozidiel nahradí celý vozový park, podobne ako súbor vozového parku. Keďže odoslaný zoznam vodičov sa považuje za celý vozový park, vždy posielajte všetkých vodičov, nielen zmeny.

Export trás a webhooky

Export trás zapíše označené trasy vo formáte CSV, XLSX, XML, JSON alebo TXT s pevnou šírkou. Tabuľka stĺpcov určuje, ktoré polia sa exportujú a pod akým záhlavím, dajú sa pridať pôvodné stĺpce vášho súboru objednávok a so správou položiek druhý súbor uvedie každú položku. Exporty môžu ísť do vášho počítača, na váš FTP server alebo do priečinka spoločnosti a pri formáte JSON sa export môže odoslať aj na webovú adresu; ak odoslanie zlyhá, systém to skúsi ešte raz.

Pre každé doručenie v momente, keď sa uskutoční, vyplňte v nastaveniach aplikácie pre vodičov adresu pre hlásenia o doručení: každé hlásenie o doručení, ktoré vodiči urobia, sa pošle aj tam, takže sa váš iný systém aktualizuje sám.

E-mail, platby, mapy a správy

• E-mail – podpísané dodacie listy odchádzajú z vášho vlastného účtu Gmail s heslom aplikácie Google; zostavy, ako je zostava paliet na konci dňa, idú na váš e-mail pre zostavy; platiaci zákazníci dostávajú z pokladne potvrdenia a vodiči potvrdenia o vklade.
• Platby – dobitia sa platia na zabezpečenej platobnej stránke Stripe, s voliteľne uloženou kartou na automatické dobitie.
• Adresy a mapy – adresy sa vyberajú z návrhov Google a pred plánovaním sa overujú na mape.
• Navigácia – aplikácia pre vodičov odovzdá každú zastávku do Waze alebo na iPhone do Apple Maps, podľa adresy alebo presných súradníc.
• SMS a WhatsApp – správy o príchode a odkazy na sledovanie zákazníkom, upozornenia manažérom, linky subdodávateľom a obrázky trás vodičom cez WhatsApp.

Často kladené otázky