Vad är PortalData Export?
PortalData är en webhook som kan ställas in för att trigga en export när en händelse läggs till i ett paket eller en försändelse.
Bakom kulisserna kontrolleras alla händelser, och om en matchar en Exportprofil triggas den anslutna Gatewayen med relevant data.
Matchningskriterierna kan vara vad som helst relaterat till en försändelse, såsom InstallationId, Händelsetyper eller specifika försändelsedetaljer.
Export kan triggas antingen när en händelse läggs till eller med regelbundna intervall.
Intervall används vanligtvis för att sammanfatta information över en viss period, med en maxgräns på 24 timmar.
Händelsers ursprung
-
On-premises / Ship Cloud / Shipment Server
Exempel: "Print" eller "Transmit" -
nShift Portal
Händelser tillagda via Shipment Viewer -
Scan App
Signatur och bild kan också exporteras -
Carrier
Återvändande datahändelser såsom "Delivered" -
ClientData
Filer från kunden
Export Gateways
-
E-post
Endast klartext -
SMS
Om mer än 160 tecken hanteras det som ett extra SMS -
FTP
Både FTP och SFTP stöds. Vi kan skicka vårt standardformat, en anpassad fil eller en obehandlad fil med all data vi har om varje händelse, om ni vill göra databehandlingen på er sida. -
HTTP
Stöder POST-förfrågningar mot en enda endpoint.
API-header-autentisering stöds med hjälp av basic authentication, bearer (token) baserad autentisering och anpassad header (nyckel+värde).
Översikt av PortalData Export
Exportprofiler
Endast nShift-anställda kan för närvarande skapa och redigera profiler.
Så här kommer du igång
Skicka en förfrågan till kundtjänst.
Ärendet bör innehålla följande information:
- Vilken typ av Gateway(s) du vill ha (e-post, SMS, FTP eller HTTP)
- Vilken/vilka händelser vi ska trigga en export på
- Exempel på den mall vi ska skapa med E-post/SMS/Fil
-
Dokumentation av API:et, om du vill använda HTTP-gatewayen
Ett exempel på en POST-förfrågan, inklusive headers och payload.
Ange HTTP-endpoint. nShift kan stödja:
- API-nyckel/token: En unik identifierare (sträng)
- OAuth: tokenbaserad autentisering (client ID och secret - JSON Web Token)
- Basic authentication: användarnamn och lösenord.
För mer information om standardformatet och exempel, se