Logga in

nShift Help Center

Kom igång med Shipment Server-integration

Avatar
Malene Tidemann
Uppdaterad

För att komma igång med Shipment Server behöver du en Shipment Server-prenumeration och ett konto. Du kan använda våra Developer Tools för att testa och bli bekant med hur du bygger förfrågningar. Den här artikeln täcker grundläggande information för att hjälpa dig komma igång med integrationen:

Åtkomst till Shipment Server API

Anslutningen till Shipment Server API sker via HTTPS, port 443.

Varje kund som använder Shipment Server behöver minst en token och en actor_id.
Token och actor_id måste skickas med i payload/body i alla förfrågningar.

Webbservern nås via REST och använder POST för alla metoder. 

 

Request body tar emot ett multipart/form-data- eller application/x-www-form-urlencoded-objekt med följande nycklar:
actor, key, command, data, options

  • actor - id för aktören
  • key - åtkomsttoken för aktören 
  • command - metoden som körs på API:et 
  • options - vissa kommandon kan styras med ytterligare inställningar
  • data - payload för kommandot (till exempel ett försändelseobjekt)
     

Datatyper:

  • Numeric - numeriska fält med värdet 0 (noll) inkluderas inte i JSON-strängen som exporteras av webbtjänsten, eftersom 0 (noll) är standardvärdet.
     
  • String - tomma strängar inkluderas inte i JSON-strängen som exporteras av webbtjänsten.
     
  • DateTime - datum och tidsstämplar formateras enligt ISO 8601-standarden. Ett exempel på ett datum är 2019-06-27 och för en tidsstämpel: 2019-06-27T10:25:00.
    Viktigt: Observera att vi endast stöder de utökade notationerna och inte de grundläggande utan bindestreck, så t.ex. 20190627 accepteras inte. Tidszoner tas bort från förfrågan och millisekunder ignoreras. 
     
  • Enum - vissa fält skickas som enums, vilket innebär att de skickas som ett heltalsvärde, men värdet har en specifik betydelse. Se bilagan med Objects and Fields för en komplett lista över möjliga värden för dessa fält.

 

Developer Tools

Developer Tools gör det möjligt att testa och bygga förfrågningar till Shipment Server API. Developer Tools är integrerade i användargränssnittet för New Bookings i Portal och visar både JSON-förfrågan till servern och JSON-svaret från servern, vilket kan användas för att granska hur förfrågan är uppbyggd.

 

Aktivera Developer Tools

  1. Logga in i nShift Portal.
     
  2. Gå till Ship > Configuration >Settings i toppmenyn.

    settings-tab.png
     
  3. Scrolla ner och markera Show developer tools under rubriken Production.

    developer-tools.png
     
  4. Du har nu tillgång till Developer Tools längst ner på alla relevanta sidor under New Bookings.

 

Använda Developer Tools

Developer Tools-sektionen har två rullgardinsmenyer där du kan ange label type och command. Observera att olika kommandon är tillgängliga beroende på vilken sida du är på. Om försändelsedata behövs i förfrågan använder Developer Tools de data du har fyllt i på den aktuella sidan. På så sätt kan du enkelt fylla i relevant information och se hur förfrågan kommer att se ut.

developer-tools-section.png

Fältet Data visar förfrågan. Vissa kommandon stöder ytterligare alternativ som läggs till i fältet Options.

Se vår lista över metoder här för att se vilka alternativ som finns tillgängliga för varje kommando. Fältet Response visar svaret du får efter att ha skickat din förfrågan.

 

 

Exempel på hur man skapar en SubmitShipment-förfrågan

SubmitShipment-kommandot skapar en försändelse och genererar ett svar med en etikett.

  1. Gå till Ship > New och fyll i alla fält relaterade till försändelsen, dvs. adressfält, transportör och varuinformation.
     
  2. I sektionen Developer Tools väljer du kommandot SubmitShipment. Detta visar förfrågan i Data-fältet med hjälp av de försändelsedata du har fyllt i. Du kan fylla i data i referensfält, meddelanden etc. och direkt se hur de läggs till i förfrågan.
     
  3. Klicka på knappen Send. Om förfrågan är lyckad får du ett svar som innehåller etiketten. Om något saknas i förfrågan får du ett felmeddelande i svaret. 
     
  4. Klicka på knappen View labels för att se etiketten/etiketterna från en lyckad SubmitShipment-förfrågan. 
     
  5. Använd Reformat data om du har redigerat data eller klistrat in en förfrågan i datafältet och vill se datan i ett mer lättläst format.

 

Tips: Om du bygger förfrågningar för Shipment Server kan du kopiera och klistra in dina förfrågningar i Data-fältet och testa dem. Om din förfrågan redan innehåller all nödvändig information behöver du inte fylla i fälten på sidan. Användargränssnittet ger bara ett enkelt sätt att se hur data läggs till i en förfrågan.

 

Se alla Commands och Options här.

 

Utskrift av etiketter

Shipment Server hanterar inte utskrift av etiketter på klientsidan. Du måste själv implementera en lösning som passar din miljö.

 

Om du skriver ut från en webbläsare kan användning av ActiveX control och/eller JavaScript vara en lösning. 

 

För utskrift från en Windows-applikation kan du använda Zebra-etikettskrivares egna språk EPL eller ZPL. I detta fall behöver du en Zebra-skrivare eller en skrivare som stöder detta. När etikettformatet EPL / ZPL sparas i en fil eller används från en ström kan du skicka det till skrivaren genom att använda ”move” eller ”copy” till en delad skrivare. Utskrift av PNG och PDF i Windows kan göras via en utskriftsdialog eller automatiseras med en process med Win32API eller med unmanaged kod med winspool.drv och Marshalling.


Du har också möjlighet att använda nShift Drop Zone-applikationen och Cloud Print. Cloud Print är en molnbaserad lösning som gör det möjligt att skriva ut på flera sätt. Dokument lagras i en kö i molnet och Drop Zone-installationer laddar ner de dokument som tillhör dem. Läs mer om Cloud Print här.

 

Om du använder termiska skrivare och upplever problem med utskrift kan du hitta hjälp på våra Printers help pages. Problem med etikettutskrift beror ofta på skrivarinställningar, kalibrering, saknade typsnitt osv.

 

Datalagring av inskickade försändelser

Inskickade försändelser lagras i databasen i 90 dagar. Försändelser som är äldre än 90 dagar tas bort varje natt för att hålla databasen så kompakt som möjligt och säkerställa hög prestanda. Dina försändelser kommer dock att vara tillgängliga i nShift Portal så länge du vill. I nShift Portal kan du se försändelsedata och statistik samt skapa rapporter.

Contact nShift för att få ett Portal-användarkonto.

Läs mer om datalagring i Portal här.

 

 

Vidare läsning

Se dessa artiklar för mer information om de olika metoderna, alternativen, objekten och fälten som är tillgängliga för Shipment Server


För en icke-teknisk introduktion till Shipment Server, se denna artikel:

En översikt över alla Shipment Server-relaterade artiklar finns här.

Relaterade artiklar