Anmelden

nShift Help Center

POD-Bilder über die ShipmentData API abrufen

Avatar
Malene Tidemann
Aktualisiert

Dieser Artikel erläutert, wie Sie ein mit einer Sendung verknüpftes POD-Bild über die ShipmentData API abrufen. Der Vorgang umfasst zwei API-Aufrufe: einen zum Abrufen der Sendungsdetails und einen zum Abrufen des Bildes selbst.

 

Authentifizierung

Wenn Sie die ShipmentData API noch nicht verwendet haben, müssen Sie zunächst einen Bearer-Token für die Authentifizierung erstellen.

  1. Melden Sie sich mit Ihrem Owner-Benutzer bei nShift Portal an.
     
  2. Gehen Sie zu Settings > API Configuration > Clients und klicken Sie auf Add.
     
  3. Benennen Sie den neuen Eintrag und fügen Sie eine Beschreibung hinzu.
     
  4. Aktivieren Sie das Kontrollkästchen Enabled.
     
  5. Setzen Sie die Allowed Scopes auf Portal Shipment Data API (public_api_portal_shipment_data) und klicken Sie auf Save.
     
  6. Client ID und Client Secret müssen kopiert und lokal gespeichert werden.
     
  7. Fordern Sie ein Zugriffstoken mit der Client ID und dem Client secret an.

Beispiel für das Anfordern 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}}"

Der Token ist 60 Minuten gültig und muss im Header aller Anfragen an die ShipmentData API enthalten sein. Detailliertere schrittweise Anweisungen mit Bildern finden Sie unter API-Konfigurationseinrichtung.



 

Sendungsdetails abrufen

Beginnen Sie damit, eine POST-Anfrage zu senden, um die Sendungsdetails abzurufen. Dies kann wie im folgenden Beispiel mithilfe des Barcodes erfolgen. Es ist auch möglich, andere Abfrageparameter zu verwenden. Die Liste der Methoden finden Sie hier.

 

BaseURL: https://api.nshiftportal.com/track/shipmentdata

 

Anfrage

POST {{URL}}/Operational/Shipments/ByBarcode


Anfrageinhalt

Der Anfrageinhalt muss application/json sein und die Nutzlast verwendet die folgenden Schlüssel

{
   "query": "{{SHIPMENTNUMBER}}",
   "startDate": "{{today-14days}}",
   "endDate": "{{today}}",
   "pageSize": 20,
   "pageIndex": 0,
   "installationTags": [],
   "actorTags": [],
   "carrierTags": []
}

 

Die Antwort enthält Ihre Sendungsdaten. Sie benötigen die Shipment UUID und die Binary UUID, um das POD-Bild abzurufen.

Die Shipment UUID befindet sich oben im Sendungsobjekt. Das Sendungsobjekt enthält ein Binaries-Array mit Objekten, die jeweils eine UUID haben, die eine Binärdatei wie ein Bild repräsentiert.

 

 

Das Bild abrufen

Sobald Sie sowohl die Shipment UUID als auch die Binary UUID haben, senden Sie eine GET-Anfrage an den folgenden Endpunkt, um das Bild herunterzuladen:

 

Anfrage

GET {{URL}}/Operational/Shipments/:shipmentUuid/binaries/:binaryUuid?isSigned=false

 

Beispiel:

/Operational/Shipments/daf511e0-367b-4786-9ad3-613858587644/binaries/2fc5a12a-73c7-4c9c-9762-38f9a7c059bc?isSigned=false

 

Die erfolgreiche Antwort (HTTP 200 OK) enthält die Bilddaten im Antwortinhalt.

Verwandte Beiträge