Log ind

nShift Help Center

Hentning af POD-billeder via ShipmentData API

Avatar
Malene Tidemann
Opdateret

Denne artikel forklarer, hvordan du henter et POD-billede tilknyttet en forsendelse via ShipmentData API. Processen involverer to API-kald: ét for at hente forsendelsesdetaljer og ét for at hente selve billedet.

 

Godkendelse

Hvis du ikke har brugt ShipmentData API før, skal du starte med at oprette et bearer-token til godkendelse.

  1. Log ind på nShift Portal med din Owner-bruger.
     
  2. Gå til Settings > API Configuration > Clients, og klik på Add.
     
  3. Navngiv den nye post, og tilføj en beskrivelse.
     
  4. Markér afkrydsningsfeltet Enabled.
     
  5. Angiv Allowed Scopes til Portal Shipment Data API (public_api_portal_shipment_data), og klik på Save.
     
  6. Client ID og Client Secret skal kopieres og gemmes lokalt.
     
  7. Anmod om et adgangstoken ved hjælp af Client ID og Client secret.

Eksempel på, hvordan du anmoder om et 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}}"

Tokenet er gyldigt i 60 minutter og skal inkluderes i headeren for alle anmodninger til ShipmentData API. For mere detaljerede trinvise instruktioner med billeder, se API-konfigurationsopsætning.



 

Hentning af forsendelsesdetaljer

Start med at sende en POST-anmodning for at hente forsendelsesdetaljer. Dette kan gøres ved hjælp af stregkoden som i eksemplet nedenfor. Det er også muligt at bruge andre forespørgselsparametre. Se listen over metoder her.

 

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

 

Anmodning

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


Anmodningens indhold

Anmodningens indhold skal være application/json, og nyttelasten bruger følgende nøgler

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

 

Svaret indeholder dine forsendelsesdata. Du skal bruge Shipment UUID og Binary UUID for at hente POD-billedet.

Shipment UUID er placeret øverst i forsendelsesobjektet. Forsendelsesobjektet indeholder et binaries-array med objekter, der hver har en UUID, som repræsenterer en binær fil såsom et billede.

 

 

Hentning af billedet

Når du har både Shipment UUID og Binary UUID, skal du sende en GET-anmodning til følgende endpoint for at downloade billedet:

 

Anmodning

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

 

Eksempel:

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

 

Det vellykkede svar (HTTP 200 OK) vil indeholde billeddataene i svarteksten.

Relaterede artikler