Log ind

nShift Help Center

Kom godt i gang med Shipment Server-integration

Avatar
Malene Tidemann
Opdateret

For at komme i gang med Shipment Server skal du have et Shipment Server-abonnement og en konto. Du kan bruge vores Developer Tools til at teste og blive fortrolig med hvordan du opbygger forespørgsler. Denne artikel dækker de grundlæggende oplysninger, du har brug for for at komme i gang med integrationen:

Adgang til Shipment Server API

Forbindelsen til Shipment Server API sker via HTTPS, 443.

Hver kunde, der bruger Shipment Server, skal mindst have et token og et actor_id.
Token og actor_id skal medsendes i payload/body i alle forespørgsler.

Webserveren tilgås via REST og bruger POST til alle metoder. 

 

Request body modtager et multipart/form-data eller application/x-www-form-urlencoded objekt med følgende nøgler:
actor, key, command, data, options

  • actor - id på aktøren
  • key - adgangstoken for aktøren 
  • command - metoden der skal køres på API'et 
  • options - nogle kommandoer kan styres med yderligere indstillinger
  • data - payload for kommandoen (et eksempel kan være et forsendelsesobjekt)
     

Datatyper:

  • Numeric - numeriske felter med værdien 0 (nul) inkluderes ikke i JSON-strengen, der eksporteres af webservicen, da 0 (nul) er standardværdien.
     
  • String - tomme strenge inkluderes ikke i JSON-strengen, der eksporteres af webservicen.
     
  • DateTime - datoer og tidsstempler formateres efter ISO 8601-standarden. Et eksempel på en dato er 2019-06-27 og for et tidsstempel: 2019-06-27T10:25:00.
    Vigtigt: Bemærk venligst, at vi kun understøtter de udvidede notationer og ikke de grundlæggende notationer uden bindestreger, så f.eks. 20190627 accepteres ikke. Tidszoner fjernes fra forespørgslen, og millisekunder ignoreres. 
     
  • Enum - nogle felter sendes som enums, hvilket betyder, at de sendes som en heltalsværdi, men værdien har en bestemt betydning. Se appendikset med Objects and Fields for en komplet liste over mulige værdier for disse felter.

 

Developer Tools

Developer Tools gør det muligt for dig at teste og opbygge forespørgsler til Shipment Server API. Developer Tools er integreret i brugergrænsefladen for New Bookings i Portal og viser både JSON-forespørgslen til serveren og JSON-svaret fra serveren, som kan bruges til at inspicere, hvordan forespørgslen er opbygget.

 

Aktivering af Developer Tools

  1. Log ind på nShift Portal.
     
  2. Gå til Ship > Configuration >Settings i topmenuen.

    settings-tab.png
     
  3. Rul ned og marker Show developer tools under overskriften Production.

    developer-tools.png
     
  4. Du har nu adgang til Developer Tools nederst på alle relevante sider under New Bookings.

 

Brug af Developer Tools

Developer Tools-sektionen har to rullemenuer, hvor du kan angive label type og command. Bemærk, at der er forskellige kommandoer tilgængelige afhængigt af, hvilken side du er på. Hvis forsendelsesdata er nødvendige i forespørgslen, vil Developer Tools bruge de data, du har indtastet på den aktuelle side. På den måde kan du nemt udfylde relevante oplysninger og se, hvordan forespørgslen vil se ud.

developer-tools-section.png

Feltet Data viser forespørgslen. Nogle kommandoer understøtter yderligere indstillinger, som tilføjes i feltet Options.

Se vores liste over metoder her for at se, hvilke indstillinger der er tilgængelige for hver kommando. Feltet Response viser det svar, du modtager efter at have sendt din forespørgsel.

 

 

Eksempel på hvordan man opretter en SubmitShipment-forespørgsel

SubmitShipment-kommandoen opretter en forsendelse og genererer et svar med en label.

  1. Gå til Ship > New og udfyld alle felter relateret til forsendelsen, dvs. adressefelter, transportør og vareoplysninger.
     
  2. I sektionen Developer Tools vælger du kommandoen SubmitShipment. Dette vil vise forespørgslen i Data-feltet ved hjælp af de forsendelsesdata, du har udfyldt. Du kan udfylde data i referencefelter, beskeder osv. og straks se, hvordan de tilføjes til forespørgslen.
     
  3. Klik på knappen Send. Hvis forespørgslen er vellykket, vil du få et svar tilbage, der indeholder labelen. Hvis noget mangler i forespørgslen, vil du få en fejlmeddelelse i svaret. 
     
  4. Klik på knappen View labels for at se label(s) fra en vellykket SubmitShipment-forespørgsel. 
     
  5. Brug Reformat data, hvis du har redigeret det eller indsat en forespørgsel i datafeltet og ønsker data i et mere læsevenligt format.

 

Tip: Hvis du opbygger forespørgsler til Shipment Server, kan du kopiere og indsætte dine forespørgsler i Data-feltet og teste dem. Hvis din forespørgsel allerede indeholder alle nødvendige oplysninger, behøver du ikke udfylde felterne på siden. Brugergrænsefladen giver blot en nem måde at se, hvordan data tilføjes til en forespørgsel.

 

Se alle Commands og Options her.

 

Udskrivning af labels

Shipment Server håndterer ikke udskrivning af labels af nogen art på klientsiden. Du skal selv implementere en løsning, der passer til dit miljø.

 

Hvis du udskriver fra en webbrowser, kan brug af ActiveX control og/eller JavaScript være en løsning. 

 

For udskrivning fra en Windows-applikation kan du bruge Zebra-labelprinteres eget sprog EPL eller ZPL. I dette tilfælde skal du bruge en Zebra-printer eller en printer, der understøtter dette. Når labeltypen EPL / ZPL gemmes i en fil eller bruges fra en stream, kan du sende den til printeren ved at bruge "move" eller "copy" fil til en delt printer. Udskrivning af PNG og PDF i Windows kan ske via en printdialog eller automatiseres med en proces ved hjælp af Win32API eller ved brug af unmanaged kode med winspool.drv og Marshalling.


Du har også mulighed for at bruge nShifts Drop Zone-applikation og Cloud Print. Cloud Print er en cloud-baseret løsning, der giver dig mulighed for at udskrive på flere måder. Dokumenter gemmes i en kø i skyen, og Drop Zone-installationer downloader de dokumenter, der tilhører dem. Læs mere om Cloud Print her.

 

Hvis du bruger termiske printere og oplever problemer med udskrivning, kan du muligvis finde hjælp på vores Printers help pages. Problemer med labeludskrivning er ofte relateret til printerindstillinger, kalibrering, manglende skrifttyper osv.

 

Datalagring af indsendte forsendelser

Indsendte forsendelser gemmes i databasen i 90 dage. Forsendelser ældre end 90 dage slettes hver nat for at holde databasen så kompakt som muligt og sikre høj ydeevne. Dine forsendelser vil dog være tilgængelige i nShift Portal så længe, du ønsker. nShift Portal er stedet, hvor du kan se forsendelsesdata og statistikker samt lave rapporter.

Contact nShift for at få en Portal-brugerkonto.

Læs mere om datalagring i Portal her.

 

 

Yderligere læsning

Se disse artikler for mere information om de forskellige metoder, muligheder, objekter og felter, der er tilgængelige for Shipment Server


For en ikke-teknisk introduktion til Shipment Server, se denne artikel:

En oversigt over alle Shipment Server-relaterede artikler kan findes her.

Relaterede artikler