Allekirjoitettu seuranta-URL voidaan luoda CustomizationAPI:n avulla. Tämä ominaisuus on hyödyllinen, jos haluat turvallisemman linkin seurantasivulle. Yleensä seuranta-URL sisältää tilausnumeron tai viivakoodin, mutta allekirjoitetussa URL-osoitteessa nämä tiedot on salattu.
Luo allekirjoitettu seuranta-URL seuraavasti:
1. Luo Client ID ja Secret
Aloita luomalla ClientID ja ClientSecret:
- Siirry nShift Portalissa kohtaan Settings > API Configuration > Clients.
- Luo uusi Client ja valitse scope Public Customization API for customers.
-
Save ja muista ottaa talteen Client Secret.
Lisätietoja ClientID:n ja ClientSecretin luomisesta saat napsauttamalla tästä.
2. Todenna
API tukee Bearer Authentication -todennusta. Käytä ClientID:tä ja Client Secretiä tokenin hakemiseen.
Esimerkki tokenin pyytämisestä
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}}"
Vastaus
{
"access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjI3QjA1ODk4Nzc1OEUwMkMI1NiIsInR2...",
"expires_in": 3600,
"token_type": "Bearer",
"scope": "public_api_shipmentserver"
}Token on voimassa 60 minuuttia, minkä jälkeen se vanhenee ja sinun on todennettava uudelleen
Kaikissa pyynnöissä tokenin on oltava Authorization-otsakkeessa
curl --location "https://api.nshiftportal.com/track/customization/PublicTrackProfile/signedProfile" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciO..." \
--data "{{PAYLOAD}}"
3. Luo allekirjoitettu Tracking URL
Käytä käyttöoikeustokenia pyynnön tekemiseen.
Katso dokumentaatio Swagger-sivultamme täältä:
https://api.nshiftportal.com/track/swagger/index.html?urls.primaryName=CustomizationApi
Esimerkkipyyntö
{
"profileUuid": "50fc034f-3b4b-472a-ka43-a49d3ab7edff",
"query": "70730253110028750",
"expirationDate": "2024-03-10T08:07:47.305Z"
}
Esimerkkivastaus
{
"url": "https://www.nshiftportal.com/ui/track/?sid=_oOVP-V4pE-v8kfm4k_rKg"
}
POST PublicTrackProfile -toimintoa käytetään allekirjoitetun URL-osoitteen luomiseen nShift Trackin brändätylle seurantasivulle. Lue lisää täältä: Brändätyn seurantasivun määrittäminen. Tässä artikkelissa on myös tietoja julkisen profiilin luomisesta.
PublicTrackProfile-profiiliin tarvittava ProfileUuid löytyy kohdasta Track > Track > Track Public Profile:
POST PublicProfile -toimintoa käytetään allekirjoitetun URL-osoitteen luomiseen Shipment Vieweriin. Lue lisää täältä: Shipment Viewer -profiilien ja julkisten seuranta-URL-osoitteiden luominen. Tässä artikkelissa on myös tietoja julkisen profiilin luomisesta.
PublicProfile-profiiliin tarvittava ProfileUuid löytyy kohdasta Track > Settings > Public T&T URL:
Query: lähetysnumero
expirationDate: määritä, milloin URL-osoitteen tulee vanhentua