Aanmelden

nShift Help Center

POD-afbeeldingen ophalen via de ShipmentData API

Avatar
Malene Tidemann
Bijgewerkt

Dit artikel legt uit hoe u een POD-afbeelding die aan een zending is gekoppeld kunt ophalen via de ShipmentData API. Het proces bestaat uit twee API-aanroepen: één om de zendingsdetails op te halen en één om de afbeelding zelf op te halen.

 

Verificatie

Als u de ShipmentData API nog niet eerder heeft gebruikt, moet u beginnen met het aanmaken van een bearer-token voor verificatie.

  1. Log in bij nShift Portal met uw Owner-gebruiker.
     
  2. Ga naar Settings > API Configuration > Clients en klik op Add.
     
  3. Geef het nieuwe item een naam en voeg een beschrijving toe.
     
  4. Vink het selectievakje Enabled aan.
     
  5. Stel de Allowed Scopes in op Portal Shipment Data API (public_api_portal_shipment_data) en klik op Save.
     
  6. De Client ID en Client Secret moeten worden gekopieerd en lokaal worden opgeslagen.
     
  7. Vraag een toegangstoken aan met de Client ID en Client secret.

Voorbeeld van hoe u een token aanvraagt:

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}}"

Het token is 60 minuten geldig en moet worden opgenomen in de header van alle verzoeken aan de ShipmentData API. Voor meer gedetailleerde stapsgewijze instructies met afbeeldingen, zie API-configuratie instellen.



 

Zendingsdetails ophalen

Begin met het versturen van een POST-verzoek om de zendingsdetails op te halen. Dit kan worden gedaan met behulp van de barcode zoals in het onderstaande voorbeeld. Het is ook mogelijk om andere queryparameters te gebruiken. Zie de lijst met methoden hier.

 

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

 

Verzoek

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


Verzoekinhoud

De verzoekinhoud moet application/json zijn en de payload gebruikt de volgende sleutels

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

 

Het antwoord bevat uw zendingsgegevens. U heeft de Shipment UUID en de Binary UUID nodig om de POD-afbeelding op te halen.

De Shipment UUID bevindt zich bovenaan het zendingsobject. Het zendingsobject bevat een binaries-array met objecten, elk met een UUID die een binair bestand zoals een afbeelding vertegenwoordigt.

 

 

De afbeelding ophalen

Zodra u zowel de Shipment UUID als de Binary UUID heeft, stuurt u een GET-verzoek naar het volgende endpoint om de afbeelding te downloaden:

 

Verzoek

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

 

Voorbeeld:

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

 

Het geslaagde antwoord (HTTP 200 OK) bevat de afbeeldingsgegevens in de antwoordtekst.

Verwante artikelen