Anmelden

Ship Help Center

Erste Schritte mit der Shipment Server-Integration

Avatar
Malene Tidemann
Aktualisiert

Um mit Shipment Server zu beginnen, benötigen Sie ein Shipment Server-Abonnement und ein Konto. Sie können unsere Developer Tools verwenden, um Tests durchzuführen und sich mit dem Aufbau von Anfragen vertraut zu machen. Dieser Artikel behandelt die grundlegenden Informationen, die Sie für den Einstieg in die Integration benötigen:

Zugriff auf die Shipment Server API

Die Verbindung zur Shipment Server API erfolgt über HTTPS, Port 443.

Jeder Kunde, der Shipment Server verwendet, benötigt mindestens ein Token und eine actor_id.
Das Token und die actor_id müssen im Payload/Body aller Anfragen übermittelt werden.

Der Webserver wird über REST angesprochen und verwendet für alle Methoden POST. 

 

Der Request Body akzeptiert ein multipart/form-data- oder application/x-www-form-urlencoded-Objekt mit den folgenden Schlüsseln:
actor, key, command, data, options

  • actor - ID des Akteurs
  • key - Zugriffstoken für den Akteur 
  • command - die auf der API auszuführende Methode 
  • options - einige Befehle können durch zusätzliche Einstellungen gesteuert werden
  • data - der Payload für den Befehl (z. B. ein Versandobjekt)
     

Datentypen:

  • Numeric - numerische Felder mit dem Wert 0 (Null) werden nicht in den von der Webservice exportierten JSON-String aufgenommen, da 0 (Null) der Standardwert ist.
     
  • String - leere Strings werden nicht in den von der Webservice exportierten JSON-String aufgenommen.
     
  • DateTime - Datums- und Zeitstempel werden gemäß dem ISO-8601-Standard formatiert. Ein Beispiel für ein Datum ist 2019-06-27 und für einen Zeitstempel: 2019-06-27T10:25:00.
    Wichtig: Bitte beachten Sie, dass wir nur die erweiterten Notationen unterstützen und nicht die Basisnotationen ohne Bindestriche, sodass z. B. 20190627 nicht akzeptiert wird. Zeitzonen werden aus der Anfrage entfernt und Millisekunden werden ignoriert. 
     
  • Enum - einige Felder werden als Enums gesendet, was bedeutet, dass sie als Ganzzahlwert gesendet werden, der jedoch eine bestimmte Bedeutung hat. Siehe den Anhang mit Objects and Fields für eine vollständige Liste der möglichen Werte für diese Felder.

 

Developer Tools

Die Developer Tools ermöglichen es Ihnen, Anfragen an die Shipment Server API zu testen und zu erstellen. Die Developer Tools sind in die Benutzeroberfläche von New Bookings im Portal integriert und zeigen sowohl die JSON-Anfrage an den Server als auch die JSON-Antwort vom Server, die zur Analyse des Aufbaus der Anfrage verwendet werden können.

 

Aktivieren der Developer Tools

  1. Melden Sie sich im nShift Portal an.
     
  2. Gehen Sie im oberen Menü zu Ship > Configuration >Settings.

    settings-tab.png
     
  3. Scrollen Sie nach unten und aktivieren Sie Show developer tools unter der Überschrift Production.

    developer-tools.png
     
  4. Sie haben nun Zugriff auf die Developer Tools am unteren Rand aller relevanten Seiten unter New Bookings.

 

Verwendung der Developer Tools

Der Abschnitt Developer Tools enthält zwei Dropdown-Menüs, in denen Sie den label type und den command festlegen können. Beachten Sie, dass je nach Seite unterschiedliche Befehle verfügbar sind. Wenn Versanddaten in der Anfrage benötigt werden, verwenden die Developer Tools die Daten, die Sie auf der aktuellen Seite eingegeben haben. So können Sie einfach relevante Informationen eingeben und sehen, wie die Anfrage aussehen wird.

developer-tools-section.png

Das Feld Data zeigt die Anfrage an. Einige Befehle unterstützen zusätzliche Optionen, die im Feld Options hinzugefügt werden.

In unserer Methodenliste hier sehen Sie, welche Optionen für jeden Befehl verfügbar sind. Das Feld Response zeigt die Antwort an, die Sie nach dem Senden Ihrer Anfrage erhalten.

 

 

Beispiel zum Erstellen einer SubmitShipment-Anfrage

Der Befehl SubmitShipment erstellt eine Sendung und erzeugt eine Antwort mit einem Label.

  1. Gehen Sie zu Ship > New und füllen Sie alle Felder aus, die sich auf die Sendung beziehen, d. h. Adressfelder, Frachtführer und Wareninformationen.
     
  2. Wählen Sie im Abschnitt Developer Tools den Befehl SubmitShipment. Dadurch wird die Anfrage im Feld Data angezeigt, basierend auf den von Ihnen eingegebenen Versanddaten. Sie können Daten in Referenzfeldern, Nachrichten usw. eingeben und sofort sehen, wie diese zur Anfrage hinzugefügt werden.
     
  3. Klicken Sie auf die Schaltfläche Send. Wenn die Anfrage erfolgreich ist, erhalten Sie eine Antwort mit dem Label. Wenn in der Anfrage etwas fehlt, erhalten Sie eine Fehlermeldung in der Antwort. 
     
  4. Klicken Sie auf die Schaltfläche View labels, um die Labels einer erfolgreichen SubmitShipment-Anfrage anzuzeigen. 
     
  5. Verwenden Sie Reformat data, wenn Sie die Daten bearbeitet oder eine Anfrage in das Datenfeld eingefügt haben und die Daten in einem besser lesbaren Format sehen möchten.

 

Tipp: Wenn Sie Anfragen für Shipment Server erstellen, können Sie Ihre Anfragen in das Datenfeld kopieren und dort testen. Wenn Ihre Anfrage bereits alle erforderlichen Informationen enthält, müssen Sie die Felder auf der Seite nicht ausfüllen. Die Benutzeroberfläche dient lediglich dazu, einfach zu sehen, wie Daten zu einer Anfrage hinzugefügt werden.

 

Alle Commands und Options finden Sie hier.

 

Drucken von Labels

Shipment Server übernimmt keine Art des Drucks von Labels auf der Clientseite. Sie müssen selbst eine Lösung implementieren, die zu Ihrer Umgebung passt.

 

Wenn Sie aus einem Webbrowser drucken, kann die Verwendung von ActiveX control und/oder JavaScript eine Lösung sein. 

 

Für das Drucken aus einer Windows-Anwendung können Sie die eigene Sprache der Zebra-Etikettendrucker EPL oder ZPL verwenden. In diesem Fall benötigen Sie einen Zebra-Drucker oder einen Drucker, der dies unterstützt. Wenn der Labeltyp EPL / ZPL in einer Datei gespeichert oder aus einem Stream verwendet wird, können Sie ihn an den Drucker senden, indem Sie die Datei per „move“ oder „copy“ an einen freigegebenen Drucker übertragen. Das Drucken von PNG und PDF unter Windows kann über einen Druckdialog erfolgen oder automatisiert mit einem Prozess unter Verwendung der Win32API oder mit unmanaged Code unter Verwendung von winspool.drv und Marshalling.


Sie haben auch die Möglichkeit, die nShift Drop Zone-Anwendung und Cloud Print zu verwenden. Cloud Print ist eine cloudbasierte Lösung, mit der Sie auf verschiedene Arten drucken können. Dokumente werden in einer Warteschlange in der Cloud gespeichert, und Drop Zone-Installationen laden die ihnen zugewiesenen Dokumente herunter. Lesen Sie mehr über Cloud Print hier.

 

Wenn Sie Thermodrucker verwenden und Probleme beim Drucken auftreten, finden Sie möglicherweise Hilfe auf unseren Printers help pages. Probleme beim Labeldruck hängen häufig mit Druckereinstellungen, Kalibrierung, fehlenden Schriftarten usw. zusammen.

 

Datenspeicherung gesendeter Sendungen

Gesendete Sendungen werden 90 Tage lang in der Datenbank gespeichert. Sendungen, die älter als 90 Tage sind, werden jede Nacht gelöscht, um die Datenbank möglichst kompakt zu halten und eine hohe Leistung sicherzustellen. Ihre Sendungen sind jedoch im nShift Portal so lange verfügbar, wie Sie möchten. Im nShift Portal können Sie Sendungsdaten und Statistiken einsehen und Berichte erstellen.

Contact nShift, um ein Portal-Benutzerkonto zu erhalten.

Lesen Sie mehr über die Datenspeicherung im Portal hier.

 

 

Weiterführende Informationen

Siehe diese Artikel für weitere Informationen zu den verschiedenen Methoden, Optionen sowie Objekten und Feldern, die für Shipment Server verfügbar sind


Für eine nicht-technische Einführung in Shipment Server siehe diesen Artikel:

Eine Übersicht aller Shipment Server-bezogenen Artikel finden Sie hier.

Verwandte Beiträge