Het is mogelijk om een ondertekende tracking-URL te genereren met behulp van de CustomizationAPI. Deze functie is handig als je een veiligere link naar de trackingpagina wilt. Meestal bevat een tracking-URL het ordernummer of de barcode, maar bij een ondertekende URL is deze informatie versleuteld.
Volg deze stappen om een ondertekende tracking-URL te maken:
1. Client ID en Secret maken
Begin met het maken van ClientID en ClientSecret:
- Ga in nShift Portal naar Settings > API Configuration > Clients.
- Maak een nieuwe Client en kies de scope Public Customization API for customers.
-
Save en vergeet niet de Client Secret te noteren.
Voor meer informatie over het genereren van de ClientID en ClientSecret, klik hier.
2. Authenticeren
De API ondersteunt Bearer Authentication. Gebruik de ClientID en Client Secret om het token op te halen.
Voorbeeld van hoe je een token aanvraagt
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}}"
Antwoord
{
"access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjI3QjA1ODk4Nzc1OEUwMkMI1NiIsInR2...",
"expires_in": 3600,
"token_type": "Bearer",
"scope": "public_api_shipmentserver"
}Het token is 60 minuten geldig voordat het verloopt en je opnieuw moet authenticeren
Alle aanvragen moeten het token in de Authorization-header bevatten
curl --location "https://api.nshiftportal.com/track/customization/PublicTrackProfile/signedProfile" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciO..." \
--data "{{PAYLOAD}}"
3. De ondertekende Tracking URL maken
Gebruik het toegangstoken om de aanvraag te doen.
Bekijk de documentatie op onze Swagger-pagina hier:
https://api.nshiftportal.com/track/swagger/index.html?urls.primaryName=CustomizationApi
Voorbeeldverzoek
{
"profileUuid": "50fc034f-3b4b-472a-ka43-a49d3ab7edff",
"query": "70730253110028750",
"expirationDate": "2024-03-10T08:07:47.305Z"
}
Voorbeeldantwoord
{
"url": "https://www.nshiftportal.com/ui/track/?sid=_oOVP-V4pE-v8kfm4k_rKg"
}
POST PublicTrackProfile wordt gebruikt om een ondertekende URL te maken naar de branded trackingpagina van nShift Track. Lees meer hier: Een branded trackingpagina instellen. Dit artikel bevat ook informatie over het maken van een openbaar profiel.
De ProfileUuid die nodig is voor PublicTrackProfile bevindt zich onder Track > Track > Track Public Profile:
POST PublicProfile wordt gebruikt om een ondertekende URL naar Shipment Viewer te maken. Lees meer hier: Shipment Viewer-profielen en openbare tracking-URL's maken. Dit artikel bevat ook informatie over het maken van een openbaar profiel.
De ProfileUuid die nodig is voor PublicProfile bevindt zich onder Track > Settings > Public T&T URL:
Query: zendingsnummer
expirationDate: geef op wanneer de URL moet verlopen