Logg på

nShift Help Center

Kom i gang med Shipment Server-integrasjon

Avatar
Malene Tidemann
Oppdatert

For å komme i gang med Shipment Server trenger du et Shipment Server-abonnement og en konto. Du kan bruke våre Developer Tools for å teste og bli kjent med hvordan du bygger forespørsler. Denne artikkelen dekker grunnleggende informasjon for å hjelpe deg i gang med integrasjonen:

Tilgang til Shipment Server API

Tilkoblingen til Shipment Server API skjer via HTTPS, port 443.

Hver kunde som bruker Shipment Server trenger minst et token og en actor_id.
Token og actor_id må inkluderes i payload/body i alle forespørsler.

Webserveren nås via REST og bruker POST for alle metoder. 

 

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

  • actor - id til aktøren
  • key - tilgangstoken for aktøren 
  • command - metoden som kjøres på API-et 
  • options - noen kommandoer kan styres med ekstra innstillinger
  • data - payload for kommandoen (for eksempel et forsendelsesobjekt)
     

Datatyper:

  • Numeric - numeriske felt med verdien 0 (null) inkluderes ikke i JSON-strengen som eksporteres av webtjenesten, siden 0 (null) er standardverdien.
     
  • String - tomme strenger inkluderes ikke i JSON-strengen som eksporteres av webtjenesten.
     
  • DateTime - datoer og tidsstempler formateres i henhold til ISO 8601-standarden. Et eksempel på en dato er 2019-06-27 og for et tidsstempel: 2019-06-27T10:25:00.
    Viktig: Vær oppmerksom på at vi kun støtter de utvidede notasjonene og ikke de grunnleggende notasjonene uten bindestreker, så for eksempel 20190627 blir ikke akseptert. Tidssoner fjernes fra forespørselen og millisekunder ignoreres. 
     
  • Enum - noen felt sendes som enums, noe som betyr at de sendes som en heltallsverdi, men verdien har en bestemt betydning. Se vedlegget med Objects and Fields for en komplett liste over mulige verdier for disse feltene.

 

Developer Tools

Developer Tools lar deg teste og bygge forespørsler til Shipment Server API. Developer Tools er integrert i brukergrensesnittet for New Bookings i Portal og viser både JSON-forespørselen til serveren og JSON-responsen fra serveren, som kan brukes til å inspisere hvordan forespørselen er bygget.

 

Aktivering av Developer Tools

  1. Logg inn i nShift Portal.
     
  2. Gå til Ship > Configuration >Settings i toppmenyen.

    settings-tab.png
     
  3. Scroll ned og merk Show developer tools under overskriften Production.

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

 

Bruk av Developer Tools

Developer Tools-seksjonen har to nedtrekksmenyer der du kan angi label type og command. Merk at det finnes ulike kommandoer avhengig av hvilken side du er på. Hvis forsendelsesdata er nødvendig i forespørselen, vil Developer Tools bruke dataene du har fylt inn på gjeldende side. På denne måten kan du enkelt fylle inn relevant informasjon og se hvordan forespørselen vil se ut.

developer-tools-section.png

Feltet Data viser forespørselen. Noen kommandoer støtter ekstra alternativer, som legges til i feltet Options.

Se vår liste over metoder her for å se hvilke alternativer som er tilgjengelige for hver kommando. Feltet Response viser svaret du mottar etter at du har sendt forespørselen.

 

 

Eksempel på hvordan du oppretter en SubmitShipment-forespørsel

SubmitShipment-kommandoen oppretter en forsendelse og genererer et svar med en etikett.

  1. Gå til Ship > New og fyll ut alle felter relatert til forsendelsen, dvs. adressefelter, transportør og vareinformasjon.
     
  2. I seksjonen Developer Tools velger du kommandoen SubmitShipment. Dette vil vise forespørselen i Data-feltet basert på forsendelsesdataene du har fylt inn. Du kan fylle inn data i referansefelter, meldinger osv., og umiddelbart se hvordan de legges til i forespørselen.
     
  3. Klikk på Send-knappen. Hvis forespørselen er vellykket, vil du få et svar som inneholder etiketten. Hvis noe mangler i forespørselen, vil du få en feilmelding i svaret. 
     
  4. Klikk på View labels-knappen for å se etiketten(e) fra en vellykket SubmitShipment-forespørsel. 
     
  5. Bruk Reformat data hvis du har redigert data eller limt inn en forespørsel i datafeltet og ønsker å se dataene i et mer lesbart format.

 

Tips: Hvis du bygger forespørsler for Shipment Server, kan du kopiere og lime inn forespørslene dine i Data-feltet og teste dem. Hvis forespørselen allerede inneholder all nødvendig informasjon, trenger du ikke fylle ut feltene på siden. Brukergrensesnittet gir bare en enkel måte å se hvordan data legges til i en forespørsel.

 

Se alle Commands og Options her.

 

Utskrift av etiketter

Shipment Server håndterer ikke utskrift av etiketter av noe slag på klientsiden. Du må selv implementere en løsning som passer ditt miljø.

 

Hvis du skriver ut fra en nettleser, kan bruk av ActiveX control og/eller JavaScript være en løsning. 

 

For utskrift fra en Windows-applikasjon kan du bruke Zebra-etikettskriveres eget språk EPL eller ZPL. I dette tilfellet trenger du en Zebra-skriver eller en skriver som støtter dette. Når etikettformatet EPL / ZPL lagres i en fil eller brukes fra en strøm, kan du sende det til skriveren ved å bruke «move» eller «copy» til en delt skriver. Utskrift av PNG og PDF i Windows kan gjøres via en utskriftsdialog eller automatiseres med en prosess ved hjelp av Win32API eller ved bruk av unmanaged kode med winspool.drv og Marshalling.


Du har også muligheten til å bruke nShift sin Drop Zone-applikasjon og Cloud Print. Cloud Print er en skybasert løsning som lar deg skrive ut på flere måter. Dokumenter lagres i en kø i skyen, og Drop Zone-installasjoner laster ned dokumentene som tilhører dem. Les mer om Cloud Print her.

 

Hvis du bruker termiske skrivere og opplever problemer med utskrift, kan du finne hjelp på våre Printers help pages. Problemer med etikettutskrift er ofte relatert til skriverinnstillinger, kalibrering, manglende fonter osv.

 

Datalagring av innsendte forsendelser

Innsendte forsendelser lagres i databasen i 90 dager. Forsendelser eldre enn 90 dager slettes hver natt for å holde databasen så kompakt som mulig og sikre høy ytelse. Dine forsendelser vil likevel være tilgjengelige i nShift Portal så lenge du ønsker. nShift Portal er stedet hvor du kan se forsendelsesdata og statistikk samt lage rapporter.

Contact nShift for å få en Portal-brukerkonto.

Les mer om datalagring i Portal her.

 

 

Videre lesning

Se disse artiklene for mer informasjon om de ulike metodene, alternativene, objektene og feltene som er tilgjengelige for Shipment Server


For en ikke-teknisk introduksjon til Shipment Server, se denne artikkelen:

En oversikt over alle Shipment Server-relaterte artikler finner du her.

Relaterte artikler