Det er mulig å generere en signert sporings-URL ved hjelp av CustomizationAPI. Denne funksjonen er nyttig hvis du ønsker en sikrere lenke til sporingssiden. Vanligvis inneholder en sporings-URL ordrenummeret eller strekkoden, men med en signert URL er denne informasjonen kryptert.
Følg disse trinnene for å opprette en signert sporings-URL:
1. Opprett Client ID og Secret
Start med å opprette ClientID og ClientSecret:
- I nShift Portal går du til Settings > API Configuration > Clients.
- Opprett en ny Client og velg scope Public Customization API for customers.
-
Save og husk å notere Client Secret.
For mer informasjon om generering av ClientID og ClientSecret, klikk her.
2. Autentiser
API-et støtter Bearer Authentication. Bruk ClientID og Client Secret for å hente tokenet.
Eksempel på hvordan du ber om et token
curl -X POST "https://account.nshiftportal.com/idp/connect/token"
--header "Content-Type: application/x-www-form-urlencoded"
--data-urlencode "grant_type=client_credentials"
--data-urlencode "client_id={{CLIENT_ID}}"
--data-urlencode "client_secret={{CLIENT_SECRET}}"
Svar
{
"access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjI3QjA1ODk4Nzc1OEUwMkMI1NiIsInR2...",
"expires_in": 3600,
"token_type": "Bearer",
"scope": "public_api_shipmentserver"
}Tokenet er gyldig i 60 minutter før det utløper, og du må autentisere på nytt
Alle forespørsler må ha tokenet i Authorization-headeren
curl --location "https://api.nshiftportal.com/track/customization/PublicTrackProfile/signedProfile" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciO..." \
--data "{{PAYLOAD}}"
3. Opprett den signerte Tracking URL-en
Bruk tilgangstokenet til å gjøre forespørselen.
Se dokumentasjonen på Swagger-siden vår her:
https://api.nshiftportal.com/track/swagger/index.html?urls.primaryName=CustomizationApi
Eksempel på forespørsel
{
"profileUuid": "50fc034f-3b4b-472a-ka43-a49d3ab7edff",
"query": "70730253110028750",
"expirationDate": "2024-03-10T08:07:47.305Z"
}
Eksempel på svar
{
"url": "https://www.nshiftportal.com/ui/track/?sid=_oOVP-V4pE-v8kfm4k_rKg"
}
POST PublicTrackProfile brukes til å opprette en signert URL til nShift Tracks brandede sporingsside. Les mer her: Sette opp en branded sporingsside. Denne artikkelen inneholder også informasjon om oppretting av en offentlig profil.
ProfileUuid som trengs for PublicTrackProfile, finnes under Track > Track > Track Public Profile:
POST PublicProfile brukes til å opprette en signert URL til Shipment Viewer. Les mer her: Opprette Shipment Viewer-profiler og offentlige sporings-URL-er. Denne artikkelen inneholder også informasjon om oppretting av en offentlig profil.
ProfileUuid som trengs for PublicProfile, finnes under Track > Settings > Public T&T URL:
Query: forsendelsesnummer
expirationDate: angi når URL-en skal utløpe