Die API ermöglicht es anderen Systemen, sich elektronisch mit Deliveo zu verbinden.

Über die API können Sie globale Informationen von Deliveo abrufen, eine Sendung von einer anderen Software aus buchen oder den aktuellen Status einer bestimmten Sendung abfragen. Es gibt zwei Arten von API-Schlüsseln innerhalb des Deliveo-Systems:

Administrativer API-Schlüssel

Ein administrativer API-Schlüssel sollte erstellt werden, wenn Sie Deliveo mit einem anderen System verbinden wollen, das Zugriff auf alle Daten aller Kunden in Deliveo hat (z.B. andere Systeme des Kurierdienstes). Es kann eine unbegrenzte Anzahl von API-Schlüsseln erstellt werden. Für eine sichere Nutzung sollten Sie für jedes autorisierte System einen eigenen API-Schlüssel erstellen und diesen löschen, wenn der Zugriff beendet ist.

API-Schlüssel auf Client-Ebene

Zur Nutzung muss ein API-Schlüssel für den Kunden im Menü Stammdaten / Kunden unter Kundeneigenschaften erstellt werden. Die Partei mit einem API-Schlüssel auf Mandantenebene hat nur Zugriff auf ihre eigenen und globalen Daten.

API-Schlüssel sollten als vertrauliche Daten behandelt werden, da Unbefugte Daten abrufen oder sogar ein Paket an das Courier-System senden können. Sollte ein API-Schlüssel versehentlich in unbefugte Hände geraten, generieren Sie sofort einen neuen und geben Sie den neu generierten API-Schlüssel an diejenigen weiter, die legitime Nutzer dieser Funktion sind.

Die API-Dokumentation finden Sie hier: swagger.deliveo.eu