Integrationen und API

Welche Integrationen bietet OptiRoutes?

Lieferungen aus einer Datei, per FTP oder SFTP laden

Die einfachste Integration ist die Datei, die Ihr System bereits exportiert. Auf dem Lieferungsbildschirm liest Lieferungen laden eine Excel- oder CSV-Datei ein; Sie ordnen jedes Systemfeld – Adresse, Kundenname, Lieferungsnummer, Menge und so weiter – einmal Ihrem Spaltennamen zu, und jede spätere Datei wird genauso geladen. Bei einer TXT-Datei mit fester Feldbreite geben Sie statt der Spaltennamen die Zeichenpositionen an. Zeilen lassen sich über ein Markierungswort in den Bemerkungen überspringen, ein zweites Markierungswort kann die Adresse ersetzen, und Sie entscheiden, ob eine bestehende Lieferungsnummer aktualisiert oder neu hinzugefügt wird.

Um manuelle Schritte ganz zu vermeiden, wählen Sie in den Einstellungen eine automatische Lademethode:

• Der OptiRoutes Dateiserver – Ihr System legt die nach Datum benannte Tagesdatei im Ordner Ihres Unternehmens auf dem FTP-Server oder auf dem verschlüsselten SFTP-Server ab.
• Ihr eigener FTP-Server – OptiRoutes verbindet sich mit dem Benutzer, den Sie angeben, und lädt die mit dem heutigen Datum benannte oder die zuletzt aktualisierte Datei.
• Automatischer Import und Export – Lieferungen werden von selbst geladen, und auch die Routen werden geplant, ganz ohne Klick.
• Die Datei-API – Ihre Software lädt die Lieferdatei per HTTPS hoch, wie unten beschrieben.

Auf dem Kundenbildschirm legt eine Excel- oder CSV-Datei mit Kundennummer, Name, Adresse, Standzeit sowie Öffnungs- und Schließzeiten Kunden und ihre Zeitfenster an oder aktualisiert sie.

Die Datei-API: Lieferungen hinein, PODs und Berichte hinaus

Jedes Unternehmen in OptiRoutes hat einen eigenen privaten Dateiordner: die geladenen Lieferungen, die unterschriebenen Lieferscheine mit Fotos und Unterschriften, die Routenexporte und die Berichte zum Tagesende. Mit der Datei-API lesen und schreiben Ihre Systeme diesen Ordner direkt per HTTPS, ohne FTP-Server dazwischen. Der Manager des Unternehmens wechselt unter Einstellungen → API & Dateien zwischen FTP und API und erstellt dort die Schlüssel – eine Anfrage an den Support ist nicht nötig, und neue Unternehmen starten direkt mit der API.

Die Aufrufe umfassen das Prüfen des Schlüssels, das Auflisten eines Ordners, Herunterladen, Hochladen (bis zu 50 MB pro Datei) und Löschen selbst hochgeladener Dateien, das Auflisten der POD-Dateien eines Tages nach Lieferung und Art sowie das Herunterladen aller POD-Dateien eines Tages als eine ZIP-Datei. Die Anleitung enthält Codebeispiele in Python, C# und Node.js sowie ein PowerShell-Skript, das einen Ordner auf Ihrem Server mit dem Unternehmensordner synchron hält – ein an FTP gewöhntes Team kann also weiterarbeiten wie bisher. Lesen Sie die Anleitung zur Datei-API.

Wie sind API-Schlüssel abgesichert?

• Minimale Rechte – jeder Schlüssel erhält nur die Berechtigungen, die er braucht: nur unterschriebene PODs, alle Dateien lesen oder Lieferungen und Inbox-Dateien hochladen.
• Zugelassene Adressen – ein Schlüssel lässt sich auf die festen IP-Adressen Ihres Servers beschränken.
• Ablauf und Rotation – ein Schlüssel kann nach einer bestimmten Anzahl von Tagen ablaufen; erstellen Sie einen neuen Schlüssel, stellen Sie um und widerrufen Sie dann den alten, ganz ohne Ausfallzeit.
• Sofortiger Widerruf – ein widerrufener Schlüssel funktioniert innerhalb von 30 Sekunden nicht mehr.
• Protokollierung – jeder Aufruf wird mit Zeit, Adresse, Datei und Antwort protokolliert und dem Manager angezeigt.
• Sichere Speicherung – OptiRoutes speichert nur einen SHA-256-Fingerabdruck jedes Schlüssels; Verbindungen laufen über HTTPS mit TLS 1.2 oder höher, und ein Schlüssel erreicht nur den Ordner seines eigenen Unternehmens.

Grenzen: 300 Anfragen pro Minute und Schlüssel, 50 MB pro Datei, 20 aktive Schlüssel pro Unternehmen und bis zu 5.000 Einträge in einer Ordnerauflistung.

Die Berichts- und Push-API

Für Reporting-Tools und ERP-Konnektoren stellt eine separate API unter api-users.optiroutes.com die Daten Ihres Unternehmens als Berichte bereit und nimmt übertragene Daten an. Eine Adresse und ein Token, das OptiRoutes für Ihr Unternehmen ausstellt, decken jeden Aufruf ab. Auf der Dokumentationsseite können Sie Ihr Token einfügen und sehen, welche Berichte für Sie freigeschaltet sind und wie die Spalten Ihres Kontos zugeordnet sind: zur API-Dokumentation.

Zwei Push-Aufrufe arbeiten in die andere Richtung: Das Übertragen von Lieferungen schreibt die Lieferdatei des Tages und startet das automatische Laden, und das Übertragen von Fahrern, Linien und Fahrzeugen ersetzt die gesamte Flotte, wie eine Flottendatei. Weil die übertragene Fahrerliste als vollständige Flotte gilt, senden Sie immer alle Fahrer, nicht nur die Änderungen.

Routenexport und Webhooks

Der Routenexport schreibt die markierten Routen als CSV, XLSX, XML, JSON oder TXT mit fester Feldbreite. Eine Spaltentabelle legt fest, welche Felder unter welcher Überschrift ausgegeben werden, Originalspalten Ihrer Lieferdatei lassen sich ergänzen, und mit Artikelverwaltung listet eine zweite Datei jeden Artikel auf. Exporte gehen auf Ihren Computer, auf Ihren FTP-Server oder in den Unternehmensordner, und mit JSON lässt sich der Export auch an eine Webadresse senden; schlägt das Senden fehl, versucht es das System ein weiteres Mal.

Für jede Lieferung in dem Moment, in dem sie passiert, tragen Sie in den Einstellungen der Fahrer-App die Adresse für Lieferberichte ein: Jeder Lieferbericht der Fahrer wird zusätzlich dorthin gesendet, sodass sich ein anderes System von Ihnen von selbst aktualisiert.

E-Mail, Zahlungen, Karten und Nachrichten

• E-Mail – unterschriebene Lieferscheine gehen von Ihrem eigenen Gmail-Konto mit einem Google-App-Passwort aus; Berichte wie der Palettenbericht zum Tagesende gehen an Ihre Berichts-E-Mail; zahlende Kunden erhalten Quittungen und Fahrer Einzahlungsbestätigungen von der Kasse.
• Zahlungen – Aufladungen werden auf einer sicheren Zahlungsseite von Stripe bezahlt, optional mit gespeicherter Karte für die automatische Aufladung.
• Adressen und Karten – Adressen werden aus Google-Vorschlägen gewählt und vor der Planung auf der Karte geprüft.
• Navigation – die Fahrer-App übergibt jeden Stopp an Waze oder auf dem iPhone an Apple Maps, nach Adresse oder exakten Koordinaten.
• SMS und WhatsApp – Ankunftsnachrichten und Tracking-Links an Kunden, Hinweise an Manager, Linien an Subunternehmer und Routenbilder per WhatsApp an Fahrer.

Häufig gestellte Fragen