Integraties en API

Welke integraties biedt OptiRoutes?

Orders laden uit een bestand, via FTP of SFTP

De eenvoudigste integratie is het bestand dat uw systeem al exporteert. Op het orderscherm leest Leveringen laden een Excel- of CSV-bestand; u koppelt elk systeemveld — adres, klantnaam, ordernummer, hoeveelheid enzovoort — één keer aan uw kolomnaam, en elk later bestand wordt op dezelfde manier geladen. Voor een TXT-bestand met vaste breedte geeft u tekenposities op in plaats van kolomnamen. Rijen kunnen worden overgeslagen met een markeringswoord in de opmerkingen, een tweede markering kan het adres vervangen, en u bepaalt of een bestaand ordernummer wordt bijgewerkt of als nieuw wordt toegevoegd.

Wilt u er geen handwerk meer aan hebben, kies dan in de instellingen een automatische laadmethode:

• De bestandsserver van OptiRoutes — uw systeem zet het dagbestand, genoemd naar de datum, in de map van uw bedrijf op de FTP-server of op de versleutelde SFTP-server.
• Uw eigen FTP-server — OptiRoutes maakt verbinding met de gebruiker die u opgeeft en laadt het bestand met de datum van vandaag in de naam, of het laatst bijgewerkte bestand.
• Automatische import en export — orders worden vanzelf geladen en ook de routes worden gepland, zonder dat er een klik nodig is.
• De bestanden-API — uw software uploadt het ordersbestand via HTTPS, zoals hieronder beschreven.

Op het klantenscherm maakt of werkt een Excel- of CSV-bestand met klantnummer, naam, adres, stoptijd en openings- en sluitingstijden klanten en hun tijdvensters bij.

De bestanden-API: orders erin, POD's en rapporten eruit

Elk bedrijf in OptiRoutes heeft een eigen privémap met bestanden: de orders die het laadt, de ondertekende afleverbonnen met hun foto's en handtekeningen, de route-exports en de rapporten aan het einde van de dag. Met de bestanden-API lezen en schrijven uw systemen die map rechtstreeks via HTTPS, zonder FTP-server ertussen. De manager van het bedrijf schakelt tussen FTP en de API onder Instellingen → API en bestanden en maakt daar de sleutels aan — er is geen verzoek aan support nodig, en nieuwe bedrijven beginnen met de API.

De aanroepen omvatten het controleren van de sleutel, een map opvragen, downloaden, uploaden (tot 50 MB per bestand) en het verwijderen van bestanden die u hebt geüpload, de POD-bestanden van een dag per order en soort opvragen, en alle POD-bestanden van een dag als één ZIP downloaden. De handleiding bevat codevoorbeelden in Python, C# en Node.js, en een PowerShell-script dat een map op uw server synchroon houdt met de bedrijfsmap — zodat een team dat aan FTP gewend is, op dezelfde manier kan blijven werken. Lees het in de handleiding van de bestanden-API.

Hoe zijn API-sleutels beveiligd?

• Minimale rechten — elke sleutel krijgt alleen de rechten die hij nodig heeft: alleen ondertekende POD's, alle bestanden lezen, of orders en inboxbestanden uploaden.
• Toegestane adressen — een sleutel kan worden beperkt tot de vaste IP-adressen van uw server.
• Vervaldatum en rotatie — een sleutel kan na een aantal dagen verlopen; maak een nieuwe sleutel, schakel over en trek daarna de oude in, zonder onderbreking.
• Direct intrekken — een ingetrokken sleutel werkt binnen 30 seconden niet meer.
• Audit — elke aanroep wordt gelogd met tijd, adres, bestand en antwoord, en aan de manager getoond.
• Veilig opgeslagen — OptiRoutes bewaart alleen een SHA-256-vingerafdruk van elke sleutel; verbindingen lopen via HTTPS met TLS 1.2 of hoger, en een sleutel heeft alleen toegang tot de map van zijn eigen bedrijf.

Limieten: 300 verzoeken per minuut per sleutel, 50 MB per bestand, 20 actieve sleutels per bedrijf, en maximaal 5.000 items in één mapoverzicht.

De rapporten- en push-API

Voor rapportagetools en ERP-koppelingen levert een aparte API op api-users.optiroutes.com de gegevens van uw bedrijf als rapporten en neemt hij aangeleverde gegevens aan. Eén adres en één token, door OptiRoutes voor uw bedrijf uitgegeven, dekken elke aanroep. Op de documentatiepagina plakt u uw token en ziet u welke rapporten voor u openstaan en wat de kolomkoppeling van uw account is: lees de API-documentatie.

Twee push-aanroepen werken de andere kant op: orders pushen schrijft het ordersbestand van de dag en start het automatisch laden, en chauffeurs, lijnen en voertuigen pushen vervangt het hele wagenpark, zoals een wagenparkbestand. Omdat de gepushte chauffeurslijst als het volledige wagenpark geldt, stuurt u altijd alle chauffeurs, niet alleen de wijzigingen.

Routes exporteren en webhooks

Route-export schrijft de gemarkeerde routes in CSV, XLSX, XML, JSON of TXT met vaste breedte. Een kolommentabel bepaalt welke velden worden uitgevoerd en onder welke kop, originele kolommen van uw ordersbestand kunnen worden toegevoegd, en met artikelbeheer toont een tweede bestand elk artikel. Exports kunnen naar uw computer, uw FTP-server of de bedrijfsmap gaan, en met JSON kan de export ook naar een webadres worden gestuurd; mislukt het versturen, dan probeert het systeem het nog één keer.

Wilt u elke levering volgen op het moment dat ze plaatsvindt, vul dan het adres voor leveringsrapporten in bij de instellingen van de chauffeursapp: elk leveringsrapport van de chauffeurs wordt ook daarheen gestuurd, zodat een ander systeem van u zichzelf bijwerkt.

E-mail, betalingen, kaarten en berichten

• E-mail — ondertekende afleverbonnen worden verstuurd vanuit uw eigen Gmail-account met een Google-app-wachtwoord; rapporten zoals het palletrapport aan het einde van de dag gaan naar uw e-mailadres voor rapporten; betalende klanten krijgen kwitanties en chauffeurs afdrachtbevestigingen vanuit de kas.
• Betalingen — opwaarderingen worden betaald op een beveiligde betaalpagina van Stripe, met een optioneel bewaarde kaart voor automatisch opwaarderen.
• Adressen en kaarten — adressen worden gekozen uit de suggesties van Google en vóór de planning op de kaart geverifieerd.
• Navigatie — de chauffeursapp geeft elke stop door aan Waze, of aan Apple Kaarten op een iPhone, op adres of op exacte coördinaten.
• SMS en WhatsApp — aankomstberichten en volglinks voor klanten, meldingen voor managers, lijnen voor onderaannemers, en routeafbeeldingen voor chauffeurs via WhatsApp.

Veelgestelde vragen