API-Schlüssel und Webhooks

Schlüssel für Ihr eigenes ERP, TMS oder WMS erstellen, Webhooks einrichten und NAV-Schlüssel für Routen und Adressen.

Zuletzt aktualisiert: Hilfe nötig? Support kontaktieren

INTEGALL kennt zwei Arten von Schlüsseln für externe Systeme:

  • API-Schlüssel und Webhooks für die INTEGALL-API: Sendungen lesen, Transporte anfragen, Rechnungen lesen und bei einem Ereignis Nachrichten empfangen. Sie finden sie unten unter EinstellungenIntegrationen auf der Karte API und Webhooks.
  • NAV-Schlüssel für den INTEGALL NAV-Server (Routen und Adressen). Sie finden sie unter EinstellungenAPI-Schlüssel.

Die technische Beschreibung für Ihren IT-Partner finden Sie unter Entwickler (API).

Einen API-Schlüssel erstellen#

  1. Gehen Sie zu EinstellungenIntegrationen und scrollen Sie zu API und Webhooks. Dort stehen auch die API-Adresse und ein Link zur Technische Beschreibung (OpenAPI).
  2. Wählen Sie + Neuer API-Schlüssel.
  3. Füllen Sie das Feld Name (wofür ist dieser Schlüssel?) aus, zum Beispiel mit ERP-Anbindung.
  4. Wählen Sie die Berechtigungen: Sendungen lesen, Transporte anfragen, Rechnungen lesen, Webhooks verwalten. Vergeben Sie nur, was das System braucht.
  5. Haken Sie bei Bedarf Testschlüssel (Schreibvorgänge werden nur geprüft, nichts gespeichert) an, um zuerst zu testen.
  6. Wählen Sie, wie lange der Schlüssel Gültig ist: bis ich ihn widerrufe, 30, 90 oder 365 Tage.
  7. Geben Sie den Code aus Ihrer Authenticator-App ein und wählen Sie Schlüssel erstellen.
  8. Der Schlüssel wird nur ein einziges Mal angezeigt. Kopieren Sie ihn mit Kopieren, bewahren Sie ihn sicher auf (zum Beispiel in einem Passwort-Tresor) und wählen Sie Ich habe es gespeichert.

Sie können höchstens 20 aktive Schlüssel haben.

Schlüssel verwalten#

Die Tabelle zeigt pro Schlüssel die Spalten Name, Berechtigungen (mit Test für einen Testschlüssel), Status (Aktiv, Zurückgezogen oder Abgelaufen) und Nutzung: wann der Schlüssel zuletzt verwendet wurde und wie viele Aufrufe es in den letzten 24 Stunden gab.

Mit Zurückziehen und Ja, widerrufen ist ein Schlüssel sofort ungültig. Einen Schlüssel ersetzen Sie so: Erstellen Sie einen neuen Schlüssel, hinterlegen Sie ihn in Ihrem System und widerrufen Sie danach den alten.

Webhooks#

Mit einem Webhook sendet INTEGALL eine Nachricht an Ihre Adresse, sobald etwas geschieht. Jede Nachricht ist signiert (X-INTEGALL-Signature).

  1. Wählen Sie + Neuer Webhook.
  2. Geben Sie die Adresse (https) ein, zum Beispiel https://erp.ihrunternehmen.be/integall. Die Adresse muss https verwenden und einen öffentlichen Domainnamen haben (keine IP-Adresse und keinen internen Namen).
  3. Wählen Sie die Ereignisse: Sendungsstatus geändert, Rechnung endgültig und Rechnung bezahlt.
  4. Geben Sie den Code aus Ihrer Authenticator-App ein und wählen Sie Webhook hinzufügen.
  5. Das Signaturgeheimnis wird nur ein einziges Mal angezeigt. Geben Sie es Ihrem IT-Partner; er prüft damit jede Nachricht.

Pro Webhook sehen Sie die letzte Zustellung mit HTTP-Status, wie viele Nachrichten in der Warteschlange stehen und wie viele in den letzten 7 Tagen fehlgeschlagen sind, und unter Letzte Zustellungen die Details.

  • Testnachricht senden: Eine Testnachricht geht innerhalb einer Minute raus.
  • Fehlgeschlagene erneut senden: sendet die fehlgeschlagenen Zustellungen der letzten 7 Tage erneut.
  • Ausschalten oder Einschalten sowie Löschen.

Eine fehlgeschlagene Zustellung wird etwa 28 Stunden lang erneut versucht. Antwortet Ihre Adresse länger als 24 Stunden nicht, schaltet INTEGALL den Webhook automatisch aus und nennt den Grund. Sie können höchstens 10 Webhooks haben.

EinstellungenAPI-Schlüssel zeigt die NAV-Schlüssel: Schlüssel für externe Systeme (ERP, TMS), die Routen oder Adressen beim INTEGALL NAV-Server abfragen. Die Büro- und die Fahrer-App brauchen keinen Schlüssel; sie verwenden die eigene Anmeldung.

Berechtigungen: Routen berechnen, Adressen suchen, Kartenkacheln und Fahrzeugprofil überschreiben. Auch hier wird der Schlüssel nur ein einziges Mal angezeigt, und zum Erstellen ist ein aktueller Code nötig.