Aanmelden

Ship Help Center

Aan de slag met Shipment Server-integratie

Avatar
Malene Tidemann
Bijgewerkt

Om aan de slag te gaan met Shipment Server heb je een Shipment Server-abonnement en een account nodig. Je kunt onze Developer Tools gebruiken om te testen en vertrouwd te raken met hoe je verzoeken opbouwt. Dit artikel behandelt de basisinformatie om je op weg te helpen met de integratie:

Toegang tot de Shipment Server API

De verbinding met de Shipment Server API verloopt via HTTPS, 443.

Elke klant die Shipment Server gebruikt, heeft minimaal een token en een actor_id nodig.
Het token en de actor_id moeten in de payload/body van alle verzoeken worden meegestuurd.

De webserver wordt benaderd via REST en gebruikt POST voor alle methoden. 

 

De request body accepteert een multipart/form-data of application/x-www-form-urlencoded object met de volgende sleutels:
actor, key, command, data, options

  • actor - id van de actor
  • key - het toegangstoken voor de actor 
  • command - de methode die op de API wordt uitgevoerd 
  • options - sommige opdrachten kunnen worden aangestuurd met extra instellingen
  • data - de payload voor de opdracht (bijvoorbeeld een zendingobject)
     

Gegevenstypen:

  • Numeric - numerieke velden met de waarde 0 (nul) worden niet opgenomen in de JSON-string die door de webservice wordt geëxporteerd, omdat 0 (nul) de standaardwaarde is.
     
  • String - lege strings worden niet opgenomen in de JSON-string die door de webservice wordt geëxporteerd.
     
  • DateTime - datums en tijdstempels worden geformatteerd volgens de ISO 8601-standaard. Een voorbeeld van een datum is 2019-06-27 en voor een tijdstempel: 2019-06-27T10:25:00.
    Belangrijk: Houd er rekening mee dat we alleen de uitgebreide notaties ondersteunen en niet de basisnotaties zonder streepjes, dus bijvoorbeeld 20190627 wordt niet geaccepteerd. Tijdzones worden uit het verzoek verwijderd en milliseconden worden genegeerd. 
     
  • Enum - sommige velden worden verzonden als enums, wat betekent dat ze als een integerwaarde worden verzonden, maar dat de waarde een specifieke betekenis heeft. Zie de appendix met Objects and Fields voor een volledige lijst met mogelijke waarden voor deze velden.

 

Developer Tools

Met de Developer Tools kun je verzoeken naar de Shipment Server API testen en opbouwen. De Developer Tools zijn geïntegreerd in de gebruikersinterface van New Bookings in Portal en tonen zowel het JSON-verzoek naar de server als het JSON-antwoord van de server, waarmee je kunt bekijken hoe het verzoek is opgebouwd.

 

Developer Tools activeren

  1. Log in op nShift Portal.
     
  2. Ga naar Ship > Configuration >Settings in het bovenste menu.

    settings-tab.png
     
  3. Scroll naar beneden en vink Show developer tools aan onder de kop Production.

    developer-tools.png
     
  4. Je hebt nu toegang tot de Developer Tools onderaan alle relevante pagina’s onder New Bookings.

 

Developer Tools gebruiken

De sectie Developer Tools heeft twee dropdownmenu’s waarin je de label type en de command kunt instellen. Houd er rekening mee dat er verschillende opdrachten beschikbaar zijn afhankelijk van de pagina waarop je je bevindt. Als verzendgegevens nodig zijn in het verzoek, gebruiken de Developer Tools de gegevens die je op de huidige pagina hebt ingevuld. Op deze manier kun je eenvoudig relevante informatie invoeren en zien hoe het verzoek eruit zal zien.

developer-tools-section.png

Het veld Data toont het verzoek. Sommige opdrachten ondersteunen extra opties, die worden toegevoegd in het veld Options.

Zie onze lijst met methoden hier om te zien welke opties beschikbaar zijn voor elke opdracht. Het veld Response toont het antwoord dat je ontvangt nadat je je verzoek hebt verzonden.

 

 

Voorbeeld van het maken van een SubmitShipment-verzoek

De SubmitShipment-opdracht maakt een zending aan en genereert een antwoord met een label.

  1. Ga naar Ship > New en vul alle velden in die betrekking hebben op de zending, zoals adresvelden, vervoerder en goedereninformatie.
     
  2. Kies in de sectie Developer Tools de opdracht SubmitShipment. Dit toont het verzoek in het Data-veld met gebruik van de verzendgegevens die je hebt ingevuld. Je kunt gegevens invullen in referentievelden, berichten enz. en direct zien hoe deze aan het verzoek worden toegevoegd.
     
  3. Klik op de knop Send. Als het verzoek succesvol is, ontvang je een antwoord met het label. Als er iets ontbreekt in het verzoek, ontvang je een foutmelding in het antwoord. 
     
  4. Klik op de knop View labels om de label(s) van een succesvol SubmitShipment-verzoek te bekijken. 
     
  5. Gebruik Reformat data als je deze hebt bewerkt of een verzoek in het dataveld hebt geplakt en de gegevens in een beter leesbaar formaat wilt zien.

 

Tip: Als je verzoeken bouwt voor Shipment Server, kun je je verzoeken kopiëren en plakken in het Data-veld en ze testen. Als je verzoek al alle benodigde informatie bevat, hoef je de velden op de pagina niet in te vullen. De gebruikersinterface biedt alleen een eenvoudige manier om te zien hoe gegevens aan een verzoek worden toegevoegd.

 

Bekijk alle Commands en Options hier.

 

Labels afdrukken

Shipment Server verzorgt geen enkele vorm van labelafdruk aan de clientzijde. Je moet zelf een oplossing implementeren die past bij jouw omgeving.

 

Als je afdrukt vanuit een webbrowser, kan het gebruik van ActiveX control en/of JavaScript een oplossing zijn. 

 

Om af te drukken vanuit een Windows-applicatie kun je de eigen taal van Zebra-labelprinters gebruiken, EPL of ZPL. In dat geval heb je een Zebra-printer nodig of een printer die dit ondersteunt. Wanneer het labeltype EPL / ZPL wordt opgeslagen in een bestand of gebruikt vanuit een stream, kun je het naar de printer sturen door het bestand te “move” of “copy” naar een gedeelde printer. Het afdrukken van PNG en PDF in Windows kan via een printdialoog of geautomatiseerd met een proces via Win32API of met unmanaged code met winspool.drv en Marshalling.


Je hebt ook de mogelijkheid om de Drop Zone-applicatie van nShift en Cloud Print te gebruiken. Cloud Print is een cloudgebaseerde oplossing waarmee je op meerdere manieren kunt afdrukken. Documenten worden opgeslagen in een wachtrij in de cloud en Drop Zone-installaties downloaden de documenten die voor hen bestemd zijn. Lees meer over Cloud Print hier.

 

Als je thermische printers gebruikt en problemen ondervindt met afdrukken, kun je mogelijk hulp vinden op onze Printers help pages. Problemen met labelafdrukken houden vaak verband met printerinstellingen, kalibratie, ontbrekende lettertypen, enz.

 

Gegevensopslag van ingediende zendingen

Ingediende zendingen worden 90 dagen in de database bewaard. Zendingen ouder dan 90 dagen worden elke nacht verwijderd om de database zo compact mogelijk te houden en een hoge performance te garanderen. Je zendingen blijven echter beschikbaar in nShift Portal zolang je wilt. nShift Portal is waar je verzendgegevens en statistieken kunt bekijken en rapporten kunt maken.

Contact nShift om een Portal-gebruikersaccount te krijgen.

Lees meer over gegevensopslag in Portal hier.

 

 

Verdere lectuur

Bekijk deze artikelen voor meer informatie over de verschillende methoden, opties, objecten en velden die beschikbaar zijn voor Shipment Server


Voor een niet-technische introductie van Shipment Server, zie dit artikel:

Een overzicht van alle Shipment Server-gerelateerde artikelen is hier te vinden.

Verwante artikelen