Logg på

nShift Help Center

Hente POD-bilder ved hjelp av ShipmentData API

Avatar
Malene Tidemann
Oppdatert

Denne artikkelen forklarer hvordan du henter et POD-bilde knyttet til en forsendelse ved hjelp av ShipmentData API. Prosessen innebærer to API-kall: ett for å hente forsendelsesdetaljer og ett for å hente selve bildet.

 

Autentisering

Hvis du ikke har brukt ShipmentData API før, må du starte med å opprette et bearer-token for autentisering.

  1. Logg inn på nShift Portal med din Owner-bruker.
     
  2. Gå til Settings > API Configuration > Clients og klikk på Add.
     
  3. Gi den nye posten et navn og legg til en beskrivelse.
     
  4. Kryss av i avmerkingsboksen Enabled.
     
  5. Sett Allowed Scopes til Portal Shipment Data API (public_api_portal_shipment_data) og klikk på Save.
     
  6. Client ID og Client Secret må kopieres og lagres lokalt.
     
  7. Be om et tilgangstoken ved hjelp av Client ID og Client secret.

Eksempel på hvordan du ber 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 gyldig i 60 minutter og må inkluderes i headeren for alle forespørsler til ShipmentData API. For mer detaljerte trinnvise instruksjoner med bilder, se API-konfigurasjonsoppsett.



 

Hente forsendelsesdetaljer

Start med å sende en POST-forespørsel for å hente forsendelsesdetaljene. Dette kan gjøres ved hjelp av strekkoden som i eksemplet nedenfor. Det er også mulig å bruke andre spørringsparametere. Se listen over metoder her.

 

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

 

Forespørsel

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


Forespørselens innhold

Forespørselens innhold må være application/json og nyttelasten bruker følgende nøkler

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

 

Svaret inneholder forsendelsesdataene dine. Du trenger Shipment UUID og Binary UUID for å hente POD-bildet.

Shipment UUID er plassert øverst i forsendelsesobjektet. Forsendelsesobjektet inneholder en binaries-array med objekter, der hvert objekt har en UUID som representerer en binærfil som et bilde.

 

 

Hente bildet

Når du har både Shipment UUID og Binary UUID, sender du en GET-forespørsel til følgende endepunkt for å laste ned bildet:

 

Forespørsel

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 svaret (HTTP 200 OK) vil inneholde bildedataene i svarets innhold.

Relaterte artikler