INTEGALL für Entwickler

Die INTEGALL-API für Ihr ERP, TMS oder WMS: was es gibt, die Adresse, der erste Aufruf und was es (noch) nicht gibt.

Zuletzt aktualisiert: Hilfe nötig? Support kontaktieren

Mit der INTEGALL-API bindet ein Transportunternehmen sein eigenes ERP, TMS oder WMS an INTEGALL an. Die API ist eine REST-API mit JSON, Version v1. Diese Seiten beschreiben nur, was heute tatsächlich existiert.

Was die API kann#

OperationMethode und PfadBerechtigung
Health-CheckGET /v1/pingkein Schlüssel nötig
Technische Beschreibung (OpenAPI 3.1)GET /v1/openapi.jsonkein Schlüssel nötig
Sendungen auflistenGET /v1/shipmentsshipments:read
Eine Sendung mit ZeitleisteGET /v1/shipments/{ref}shipments:read
Einen Transport anfragenPOST /v1/shipment-requestsshipments:write
Endgültige Rechnungen auflistenGET /v1/invoicesinvoices:read

Außerdem sendet INTEGALL Webhooks bei drei Ereignissen: Der Status einer Sendung ändert sich, eine Rechnung wird endgültig, eine Rechnung wird bezahlt.

Die Adresse#

https://api.integall.com/functions/v1/api-v1

Alle obigen Pfade werden an diese Adresse angehängt, zum Beispiel https://api.integall.com/functions/v1/api-v1/v1/shipments. Die genaue Adresse steht auch im Unternehmensbereich unter API und Webhooks (API-Adresse).

In drei Schritten#

  1. Der Inhaber oder ein Administrator des Transportunternehmens erstellt im Unternehmensbereich einen API-Schlüssel. Siehe API-Schlüssel und Webhooks.
  2. Prüfen Sie, ob die API erreichbar ist:
curl https://api.integall.com/functions/v1/api-v1/v1/ping
  1. Machen Sie einen ersten Aufruf mit dem Schlüssel:
curl -H "Authorization: Bearer $INTEGALL_API_KEY" \
  "https://api.integall.com/functions/v1/api-v1/v1/shipments?limit=10"

Legen Sie den Schlüssel in einer Umgebungsvariablen ab (INTEGALL_API_KEY), nie in Ihrem Quellcode.

Regeln#

  • Verwenden Sie die API nur von einem Server aus. Legen Sie einen Schlüssel nie in einem Browser oder einer mobilen App ab.
  • Jeder Schlüssel gehört zu genau einem Transportunternehmen und sieht nur die Daten dieses Unternehmens.
  • Beginnen Sie mit einem Testschlüssel (rr_test_…): Er liest Ihre echten Daten, schreibt aber nichts.
  • Beispieldaten (im Unternehmensbereich als Beispiel gekennzeichnet) gelangen nie in die API.

Was es (noch) nicht gibt#

  • Keine API zum Schreiben außer Anfragen: Fahrten anlegen, ändern oder Rechnungen erstellen geht nur im Unternehmensbereich. Eine Anfrage über die API landet unter Anfragen, und das Büro macht daraus eine Fahrt.
  • Keine Anbindung an ein eFTI Gate: INTEGALL ist keine zertifizierte eFTI-Plattform und nicht an ein eFTI Gate eines Mitgliedstaats angebunden. Es gibt keine Schnittstelle für Behörden oder eFTI Gates. Siehe eFTI.
  • NAV-API (geplant): Die API für Lkw-Routen und Adressen ist gebaut, aber der NAV-Server ist noch nicht in Betrieb. Siehe NAV-API.
  • Webhooks über die API verwalten: Die Berechtigung webhooks:manage existiert, aber in v1 verwendet sie kein Pfad. Webhooks verwalten Sie im Unternehmensbereich.

Weiterlesen#