Wat is PortalData Export?
PortalData is een webhook die kan worden ingesteld om een export te activeren telkens wanneer een gebeurtenis wordt toegevoegd aan een pakket of zending.
Achter de schermen worden alle gebeurtenissen gecontroleerd, en als er een overeenkomt met een Exportprofiel, wordt de gekoppelde Gateway geactiveerd met de relevante gegevens.
De matchende criteria kunnen alles zijn wat met een zending te maken heeft, zoals InstallationId, gebeurtenistypen of specifieke zendinggegevens.
Exports kunnen worden geactiveerd wanneer een gebeurtenis wordt toegevoegd of op regelmatige intervallen.
Intervallen worden meestal gebruikt om informatie samen te vatten over een bepaalde periode, met een maximum van 24 uur.
Oorsprong van gebeurtenissen
-
On-premises / Ship Cloud / Shipment Server
Voorbeeld: "Print" of "Transmit" -
nShift Portal
Gebeurtenissen toegevoegd via de Shipment Viewer -
Scan App
Handtekening en afbeelding kunnen ook worden geëxporteerd -
Carrier
Retourgegevens zoals "Delivered" -
ClientData
Bestanden van de klant
Export Gateways
-
Email
Alleen platte tekst -
SMS
Als er meer dan 160 tekens zijn, wordt dit behandeld als een extra SMS -
FTP
Zowel FTP als SFTP worden ondersteund. We kunnen ons standaardformaat, een aangepast bestand of een onbewerkt bestand verzenden, met alle gegevens die we hebben over elke gebeurtenis, als u de gegevensverwerking aan uw kant wilt doen. -
HTTP
Ondersteunt POST-verzoeken naar een enkele endpoint.
API-headerauthenticatie wordt ondersteund met basis authenticatie, bearer (token) gebaseerde authenticatie en aangepaste header (sleutel+waarde).
Overzicht PortalData Export
Exportprofielen
Momenteel kunnen alleen nShift-medewerkers profielen aanmaken en bewerken.
Hoe te beginnen
Dien een verzoek in bij de klantenservice.
Het ticket moet de volgende informatie bevatten:
- Het type Gateway(s) dat u wilt (email, SMS, FTP of HTTP)
- Op welke gebeurtenis(sen) we een export moeten activeren
- Voorbeeld van de sjabloon die we moeten maken met Email/SMS/Bestand
-
Documentatie van de API, als u de HTTP gateway wilt gebruiken
Een voorbeeld van een POST-verzoek, inclusief headers en payload.
Geef de HTTP-endpoint op. nShift kan ondersteunen:
- API-sleutel/token: een unieke identificatie (string)
- OAuth: token-gebaseerde authenticatie (client-ID en geheime sleutel - JSON Web Token)
- Basis authenticatie: gebruikersnamen en wachtwoorden.
Voor meer informatie over het standaardformaat en voorbeelden, zie