Logga in

nShift Help Center

Hämta POD-bilder med ShipmentData API

Avatar
Malene Tidemann
Uppdaterad

Den här artikeln förklarar hur du hämtar en POD-bild kopplad till en försändelse med hjälp av ShipmentData API. Processen omfattar två API-anrop: ett för att hämta försändelsedetaljer och ett för att hämta själva bilden.

 

Autentisering

Om du inte har använt ShipmentData API tidigare måste du börja med att skapa en bearer-token för autentisering.

  1. Logga in på nShift Portal med din Owner-användare.
     
  2. Gå till Settings > API Configuration > Clients och klicka på Add.
     
  3. Namnge den nya posten och lägg till en beskrivning.
     
  4. Markera kryssrutan Enabled.
     
  5. Ställ in Allowed Scopes på Portal Shipment Data API (public_api_portal_shipment_data) och klicka på Save.
     
  6. Client ID och Client Secret måste kopieras och sparas lokalt.
     
  7. Begär en åtkomsttoken med hjälp av Client ID och Client secret.

Exempel på hur du begär en 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}}"

Token är giltig i 60 minuter och måste inkluderas i headern för alla förfrågningar till ShipmentData API. För mer detaljerade steg-för-steg-instruktioner med bilder, se API-konfigurationsinställning.



 

Hämta försändelsedetaljer

Börja med att skicka en POST-förfrågan för att hämta försändelsedetaljerna. Detta kan göras med hjälp av streckkoden som i exemplet nedan. Det är också möjligt att använda andra frågeparametrar. Se listan över metoder här.

 

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

 

Förfrågan

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


Förfrågans innehåll

Förfrågans innehåll måste vara application/json och nyttolasten använder följande nycklar

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

 

Svaret innehåller dina försändelsedata. Du behöver Shipment UUID och Binary UUID för att hämta POD-bilden.

Shipment UUID finns längst upp i försändelseobjektet. Försändelseobjektet innehåller en binaries-array med objekt, där varje objekt har ett UUID som representerar en binärfil såsom en bild.

 

 

Hämta bilden

När du har både Shipment UUID och Binary UUID skickar du en GET-förfrågan till följande endpoint för att ladda ned bilden:

 

Förfrågan

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

 

Exempel:

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

 

Det lyckade svaret (HTTP 200 OK) innehåller bilddata i svarets innehåll.

Relaterade artiklar