Mit der CustomizationAPI kann eine signierte Tracking-URL generiert werden. Diese Funktion ist nützlich, wenn Sie einen sichereren Link zur Tracking-Seite wünschen. Normalerweise enthält eine Tracking-URL die Bestellnummer oder den Barcode, bei einer signierten URL werden diese Informationen jedoch verschlüsselt.
Führen Sie die folgenden Schritte aus, um eine signierte Tracking-URL zu erstellen:
1. Client ID und Secret erstellen
Beginnen Sie mit der Erstellung von ClientID und ClientSecret:
- Gehen Sie in nShift Portal zu Settings > API Configuration > Clients.
- Erstellen Sie einen neuen Client und wählen Sie den Scope Public Customization API for customers.
-
Save und notieren Sie sich unbedingt das Client Secret.
Weitere Informationen zum Generieren von ClientID und ClientSecret finden Sie, wenn Sie hier klicken.
2. Authentifizieren
Die API unterstützt Bearer Authentication. Verwenden Sie ClientID und Client Secret, um das Token abzurufen.
Beispiel für die Anforderung eines Tokens
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}}"
Antwort
{
"access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjI3QjA1ODk4Nzc1OEUwMkMI1NiIsInR2...",
"expires_in": 3600,
"token_type": "Bearer",
"scope": "public_api_shipmentserver"
}Das Token ist 60 Minuten gültig, bevor es abläuft und Sie sich erneut authentifizieren müssen
Alle Anfragen müssen das Token im Authorization-Header enthalten
curl --location "https://api.nshiftportal.com/track/customization/PublicTrackProfile/signedProfile" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciO..." \
--data "{{PAYLOAD}}"
3. Die signierte Tracking URL erstellen
Verwenden Sie das Zugriffstoken, um die Anfrage zu stellen.
Die Dokumentation finden Sie auf unserer Swagger-Seite hier:
https://api.nshiftportal.com/track/swagger/index.html?urls.primaryName=CustomizationApi
Beispielanfrage
{
"profileUuid": "50fc034f-3b4b-472a-ka43-a49d3ab7edff",
"query": "70730253110028750",
"expirationDate": "2024-03-10T08:07:47.305Z"
}
Beispielantwort
{
"url": "https://www.nshiftportal.com/ui/track/?sid=_oOVP-V4pE-v8kfm4k_rKg"
}
POST PublicTrackProfile wird verwendet, um eine signierte URL zur gebrandeten Tracking-Seite von nShift Track zu erstellen. Weitere Informationen finden Sie hier: Einrichten einer gebrandeten Tracking-Seite. Dieser Artikel enthält auch Informationen zum Erstellen eines öffentlichen Profils.
Die für PublicTrackProfile benötigte ProfileUuid befindet sich unter Track > Track > Track Public Profile:
POST PublicProfile wird verwendet, um eine signierte URL zum Shipment Viewer zu erstellen. Weitere Informationen finden Sie hier: Shipment Viewer-Profile und öffentliche Tracking-URLs erstellen. Dieser Artikel enthält auch Informationen zum Erstellen eines öffentlichen Profils.
Die für PublicProfile benötigte ProfileUuid befindet sich unter Track > Settings > Public T&T URL:
Query: Sendungsnummer
expirationDate: Geben Sie an, wann die URL ablaufen soll