Kirjaudu sisään

nShift Help Center

POD-kuvien hakeminen ShipmentData API:n avulla

Avatar
Malene Tidemann
Päivitetty

Tässä artikkelissa kerrotaan, miten lähetykseen liitetty POD-kuva haetaan ShipmentData API:n avulla. Prosessi sisältää kaksi API-kutsua: yhden lähetystietojen hakemiseksi ja toisen itse kuvan hakemiseksi.

 

Todennus

Jos et ole aiemmin käyttänyt ShipmentData API:a, sinun on ensin luotava bearer-token todennusta varten.

  1. Kirjaudu sisään nShift Portaliin Owner-käyttäjälläsi.
     
  2. Siirry kohtaan Settings > API Configuration > Clients ja napsauta Add.
     
  3. Nimeä uusi merkintä ja lisää kuvaus.
     
  4. Valitse Enabled-valintaruutu.
     
  5. Aseta Allowed Scopes arvoksi Portal Shipment Data API (public_api_portal_shipment_data) ja napsauta Save.
     
  6. Client ID ja Client Secret on kopioitava ja tallennettava paikallisesti.
     
  7. Pyydä käyttöoikeustokenia käyttämällä Client ID:tä ja Client secretia.

Esimerkki tokenin pyytämisestä:

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 on voimassa 60 minuuttia ja se on sisällytettävä kaikkien ShipmentData API:lle lähetettyjen pyyntöjen otsikkoon. Tarkemmat vaiheittaiset ohjeet kuvineen löydät täältä: API-konfiguraation asetukset.



 

Lähetystietojen hakeminen

Aloita lähettämällä POST-pyyntö lähetystietojen hakemiseksi. Tämä voidaan tehdä käyttämällä viivakoodia alla olevan esimerkin mukaisesti. On myös mahdollista käyttää muita kyselyparametreja. Katso menetelmien luettelo täältä.

 

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

 

Pyyntö

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


Pyynnön sisältö

Pyynnön sisällön on oltava application/json ja hyötykuorma käyttää seuraavia avaimia

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

 

Vastaus sisältää lähetystietosi. Tarvitset Shipment UUID:n ja Binary UUID:n POD-kuvan hakemiseksi.

Shipment UUID sijaitsee lähetysobjektin yläosassa. Lähetysobjekti sisältää binaries-taulukon, joka sisältää objekteja, joilla kullakin on UUID, joka edustaa binaaritiedostoa, kuten kuvaa.

 

 

Kuvan hakeminen

Kun sinulla on sekä Shipment UUID että Binary UUID, lähetä GET-pyyntö seuraavaan endpointiin kuvan lataamiseksi:

 

Pyyntö

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

 

Esimerkki:

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

 

Onnistunut vastaus (HTTP 200 OK) sisältää kuvatiedot vastauksen rungossa.

Aiheeseen liittyvät artikkelit