Was ist PortalData Export?
PortalData ist ein Webhook, der so eingerichtet werden kann, dass bei Hinzufügen eines Ereignisses zu einem Paket oder einer Sendung ein Export ausgelöst wird.
Im Hintergrund werden alle Ereignisse überprüft, und wenn eines mit einem Exportprofil übereinstimmt, wird das verbundene Gateway mit den relevanten Daten ausgelöst.
Die Übereinstimmungskriterien können alles sein, was mit einer Sendung zu tun hat, wie z.B. InstallationId, Ereignistypen oder spezifische Sendungsdetails.
Exporte können entweder beim Hinzufügen eines Ereignisses oder in regelmäßigen Abständen ausgelöst werden.
Intervalle werden üblicherweise verwendet, um Informationen über einen festgelegten Zeitraum zusammenzufassen, maximal 24 Stunden.
Ursprung der Ereignisse
-
On-Premises / Ship Cloud / Shipment Server
Beispiel: "Drucken" oder "Übertragen" -
nShift Portal
Ereignisse, die mit dem Shipment Viewer hinzugefügt wurden -
Scan App
Unterschrift und Bild können ebenfalls exportiert werden -
Spediteur
Rückgabe-Datenereignisse wie "Zugestellt" -
ClientData
Dateien vom Kunden
Export-Gateways
-
E-Mail
Nur Klartext -
SMS
Wenn mehr als 160 Zeichen, wird dies als zusätzliche SMS behandelt -
FTP
Sowohl FTP als auch SFTP werden unterstützt. Wir können unser Standardformat, eine angepasste Datei oder eine unbearbeitete Datei mit allen Daten zu jedem Ereignis senden, falls Sie die Datenverarbeitung auf Ihrer Seite durchführen möchten. -
HTTP
Unterstützt POST-Anfragen an einen einzelnen Endpunkt.
API-Header-Authentifizierung wird unterstützt mit Basic Authentication, Bearer (Token) basierter Authentifizierung und benutzerdefiniertem Header (Schlüssel+Wert).
PortalData Export Übersicht
Export-Profile
Derzeit können nur nShift-Mitarbeiter Profile erstellen und bearbeiten.
So starten Sie
Reichen Sie eine Anfrage beim Kundenservice ein.
Das Ticket sollte folgende Informationen enthalten:
- Die Art des/der gewünschten Gateways (E-Mail, SMS, FTP oder HTTP)
- Für welches Ereignis/welche Ereignisse ein Export ausgelöst werden soll
- Beispiel der Vorlage, die wir erstellen sollen, unter Verwendung von E-Mail/SMS/Datei
-
Dokumentation der API, falls Sie das HTTP-Gateway verwenden möchten
Ein Beispiel für eine POST-Anfrage, inklusive Header und Payload.
Geben Sie den HTTP-Endpunkt an. nShift unterstützt:
- API-Schlüssel/Token: Ein eindeutiger Bezeichner (String)
- OAuth: tokenbasierte Authentifizierung (Client-ID und Geheimnis - JSON Web Token)
- Basic Authentication: Benutzername und Passwort.
Für weitere Informationen zum Standardformat und Beispiele siehe
Standard Portal Export Einrichtung