Wir bieten API-Service
für die Containerverfolgung
Hier sind die Informationen, die Sie von der
Shipsgo Tracking API erhalten
Natürlich kannst du. Es reicht aus, eine GET-Funktion mit API zu erstellen und "&mapPoint=true" am Ende der Anforderungs-URL hinzuzufügen. Dann sehen Sie die Koordinaten des Schiffes.
Nachdem Sie Ihr Konto erstellt haben, erhalten Sie einen API-Schlüssel. Sie erreichen es über Ihr Dashboard unter dem Abschnitt INTEGRATION in der linken Seitenleiste. Sie können diesen Schlüssel als Kommunikationscode zwischen Ihrem Unternehmen und Shipsgo betrachten.
Dank dieses Schlüssels erkennt das Shipsgo-System, wenn der Kunde die Tracking-Anfrage sendet, den Firmennamen und speichert die Anfrage im Firmenkonto. Anschließend sendet unser System die Benachrichtigungs-E-Mail an Sie und Ihre Kunden mit Ihrem Logo und Ihrer E-Mail-Adresse, wenn Sie dies wünschen.
Außerdem verwenden wir diesen Schlüssel auch, um den Verbrauch Ihrer Credits zu berechnen.
Bitte beachte, dass:
Jede Interaktion mit der API erfordert immer Ihren API-SCHLÜSSEL. Es wird auf Ihrem Dashboard verfügbar sein, wenn Sie ein Konto haben.
Unsere API-Dokumentation enthält detailliertere Informationen zum Erstellen einer neuen Anfrage.
Die Shipsgo-API hat 2 Methoden: Post und Get.
Da einige Informationen wie {containerNumber}, {blContainersRef}, {emailAddress} etc. benötigt werden, um das Tracking zu starten, besteht der erste Schritt darin, die Tracking-Anfrage zu erstellen. Die Nachverfolgungsanfrage wird mithilfe der Postmethode mit dem Container, dem Hauptkonnossement oder der Buchungsnummer erstellt.
Die {requestId} wird mit dem Statuscode 200 OK an die Clients zurückgegeben, wenn die Anfrage erfolgreich erstellt und an Shipsgo gesendet wurde und das bedeutet, dass die Anfrage den Server erreicht hat.
Wenn der POST fehlschlägt, wird die Fehlermeldung zurückgegeben. Die Liste der Fehlerreaktionen für die Methode finden Sie hier.
Der Client kann die GET-Methode ausführen, um Reisedaten abzurufen, indem er {containerNumber} oder {requestId} verwendet, nachdem die Erfolgsmeldung zurückgegeben wurde
Bitte beachten Sie, dass die POST-Methode idempotent ist. Es reicht aus, POST einmal für jede Spur auszuführen. Der Client kann jedoch so oft wie nötig GET-Aufrufe tätigen.
SPITZE:
- Da jede Sendung 3 Mal am Tag aktualisiert wird, reichen 3 GET-Aufrufe für jede Sendung völlig aus.
Vorsicht:
- Die Shipsgo-API stellt Daten bereit, die von der aktiven oder letzten Reise eines Containers stammen.
- Die Nachverfolgung von Hausfrachtbriefen wird nicht unterstützt. Nur die Hauptfrachtbriefnummer wird akzeptiert.
- Es reicht aus, POST einmal für jede Spur auszuführen.
Nein, da Shipsgo öffentlich zugängliche Informationen sammelt, ist die Autorisierung nicht erforderlich. Sie können Ihre Sendung jederzeit verfolgen, sobald Ihre Reederei eine der unterstützten Reedereien ist und Sie über einen API-Schlüssel verfügen.
Die Daten der Reise werden 3 mal täglich aktualisiert. Sie können also Ihre GET-Funktion so einstellen, dass sie dreimal täglich ausgelöst wird.
Ja, wir stellen API zur Verfügung. Alle Details zur API finden Sie hier.
Wenn Sie technischen Support oder weitere Informationen zur API-Integration benötigen, können Sie uns gerne über den Live-Chat oder support@shipsgo.com schreiben.
Nein, es gibt keine Beschränkung für das Posten von Tracking-Anfragen; oder einen Anruf tätigen, um Reisedaten zu erhalten. Ihr Limit für API-Aufrufe ist nur auf den Guthabenbetrag in Ihren Konten beschränkt. Ihre Credits werden nur verbraucht, wenn Sie die Sendung an das System POST. Sie zahlen nicht für GET-Reisedaten, d. h. für mehrere API-Aufrufe.
Wenn Sie die API-Integration verwenden, erhalten Sie Reiseinformationen im XML- oder JSON-Format. Eines der ersten Dinge, die Sie in der XML- ODER JSON-Datei sehen, ist der „Status“. Dieser „Status“ zeigt den Zustand der Sendungen an.
Die Bedeutungen der Status sind wie folgt;
- InProgress (StatusId = 20): Die Reederei hat noch keine Informationen über den Container veröffentlicht.
- Booked (StatusId = 30): Die Reederei hat die Reiseinformationen zu dieser Sendung geteilt. Es ist noch nicht gesegelt.
- Loaded (StatusId = 35): Die Sendung ist auf das Schiff geladen, aber das Schiff hat POL noch nicht verlassen.
- Sailing (StatusId = 40): Der Container ist unterwegs.
- Arrived (StatusId = 45): Das Schiff ist am POD angekommen, aber die Sendung wartet darauf, gelöscht zu werden
- Discharged (StatusId = 50): Der Container wurde am Entladehafen gelöscht.
- Untracked (StatusId = 60): Es ist nicht möglich, den Container zu verfolgen, da die für den Transport des Containers zuständige Reederei keinen Online-Tracking-Service hat.
Nachdem Ihre Sendungsverfolgungsanfrage bei uns eingegangen ist, überprüft unser System die Website des Transportunternehmens, um das XML-Formular auszufüllen.
1. Wenn Ihr System die Daten abruft, bevor das System die Daten von der Website des Spediteurs erfasst, erhalten Sie möglicherweise eine leere Datenantwort. Höchstwahrscheinlich haben Sie beim zweiten Anrufversuch die Daten.
2. Wenn der Beförderer die Reisedaten noch nicht bereitstellt, ist die XML-Antwort einfach leer. Unser System überprüft jedoch dreimal täglich die Website des Transportunternehmens und ruft die Daten ab, wenn sie bereit sind. Was Sie tun sollten, ist, Ihren GET-Aufruf so einzustellen, dass er dreimal täglich ausgeführt wird, und am Ende des Tages stehen Ihnen alle Daten zur Verfügung. Der Status dieser Art von Daten ist „in progress“.
3. Manchmal sind die Sendungen jedoch überhaupt nicht nachverfolgbar. Der Status dieser Art von Sendung ist „Untracked“. Die Sendung kann nicht nachverfolgt werden, wenn die Reederei überhaupt kein Trackingsystem hat oder die Containernummer keiner Reederei zugeordnet werden kann.
Beispiel für vollständige XML-Daten: https://drive.google.com/file/d/1_yHhrFHOMcBBjGUgWgAH53oxGoiNEZze/view?usp=sharing
Beispiel für vollständige JSON-Daten: https://drive.google.com/file/d/167S4Ljoo_Op8u3J5k74c-_5In2hGUbOt/view?usp=sharing
Leider können Sie mit unserer aktuellen API jede Sendung separat abfragen.
Um Daten von Shipsgo zu erhalten, sollten Sie zunächst Daten an unser System senden, indem Sie die POST-Funktion unserer API verwenden. Nach der Post sollte Ihre Anfrage uns erfolgreich erreichen. Dann können Sie die Reisedaten mit der GET-Methode der API abrufen.
Wenn Ihre Daten uns erfolgreich erreichen, dann kommt als Antwort eine Request-ID zurück. Diese IDs sind für jede Ihrer Tracking-Anfragen eindeutig und unterscheiden sich von Sendung zu Sendung. Die wichtigste Funktion dieser ID ist, dass Sie bereits mit Erhalt dieser ID sicher sein können, dass Ihre POST uns erfolgreich erreicht hat. Es ist sozusagen eine Bestätigungsnachricht von Shipsgo.
Beispiel für eine erfolgreiche Antwort-ID 1-534567
Ihr POST ist jedoch fehlgeschlagen, wenn Sie anstelle der Anforderungs-ID die folgenden Antworten erhalten. Sie müssen die Daten gemäß den Erläuterungen korrigieren und die Anfrage erneut stellen.
Antwort: "The Field (Code) Value (test1234) is not in a valid format"
Containernummer muss aus 11 Zeichen bestehen: 4 Buchstaben gefolgt von 7 Zahlen Beispiel. AAAA1234567
Antwort: "The Field (Code) Value (EGHU9483781) is not valid"
Das Format der Containernummer ist wahr, die Nummer ist jedoch ungültig. Es wäre EGHU948378-8 aufgrund der Regeln für die Erstellung von Containernummern
Antwort: "The shipping line field is required"
Sie müssen den Namen der Reederei gemäß der Shipsgo Reedereiliste eingeben
Antwort: „The Entered Value (support@gmail.com) In Field (Email) Is Not A Valid Email Address“
Sie haben die E-Mail-Adresse falsch eingegeben. Bitte kontrollieren Sie die Eingabe
Antwort: „No Active Subscription Or It Is Expire“
Wahrscheinlich ist Ihr Guthaben aufgebraucht oder Ihr Konto war aus einem anderen Grund inaktiv. Bitte kontaktieren Sie das Shipsgo-Team, wenn es passiert ist
Nachdem Sie den POST erfolgreich abgeschlossen haben, können Sie die GET-Methode ausführen, indem Sie die Regeln befolgen. Beim Ausführen von GET können einige Fehlermeldungen auftreten. Hier sind sie und ihre Bedeutung:
Fehlermeldung: "Invalid Authentication Code"
Sie verwenden einen ungültigen API-SCHLÜSSEL oder Ihr Konto darf die API-Verbindung nicht verwenden
Fehlermeldung: „No Active Subscription Or It Is Expire“
Wahrscheinlich ist Ihr Guthaben aufgebraucht oder Ihr Konto war aus einem anderen Grund inaktiv.
Fehlermeldung: „There Are No Data Related To Requested Id“
Sie geben die falsche Containernummer/Anfrage-ID ein. Oder Sie versuchen, die Containerdaten zu erhalten, von denen Sie die Tracking-Anfrage nicht an uns gesendet haben.
Alle Details zu Meilensteinen finden Sie hier.
Nein. Sie müssen lediglich die BL-Nummer übermitteln. Das System wird die Container unter dem BL mit den Reisedaten ansteuern und in XML/JSON bereitstellen.
Jede Sendung wird alle 8 Stunden nach Erstellungszeit aktualisiert, daher unterscheidet sich die Aktualisierungszeit von Sendung zu Sendung je nach Erstellungszeit. Sie können Ihre GET-Funktion jedoch dreimal täglich morgens, mittags und abends einstellen. So haben Sie am Ende des Tages alle Updates für alle Ihre Sendungen.
Wenn Sie die Sendung an Shipsgo gesendet haben, erhalten Sie eine Anforderungs-ID, wenn der POST erfolgreich war. Nachdem Sie die Anfrage-ID erhalten haben, können Sie sofort anrufen. Sie werden eine Antwort haben. Die Daten sind jedoch möglicherweise zu diesem Zeitpunkt nicht verfügbar und die XML-Datei kann null sein, da die Datenverfügbarkeit vom Spediteur abhängt. Wenn die Daten auf der Website des Spediteurs verfügbar sind, beträgt die durchschnittliche Antwortzeit Sekunden.
Wenn Sie die Suchleiste in der Live Map-Lösung, die Sie auf Ihren Websites verwenden, deaktivieren möchten Websites verwenden, können Sie die folgenden iframe-Codes verwenden.
<iframe
src="http://shipsgo.com/iframe/where-is-my-container/TEST1234567?tags=hide-search-box"
id="IframeShipsgoLiveMap"
style="height: 550px;width: 100%;"></iframe>
<script>
if (window.addEventListener)
window.addEventListener("message", ShipsgoMessagesListener);
function ShipsgoMessagesListener() {
if (event.data.Action === "LoadNewContainerCode")
document.getElementById("IframeShipsgoLiveMap").src =
"http://shipsgo.com/iframe/where-is-my-container/" +
event.data.Parameters.ContainerCode + '?tags=hide-search-box';
}
var urlParams = new URLSearchParams(window.location.search);
var defaultQuery = urlParams.get('query');
if (defaultQuery === undefined || defaultQuery === null)
defaultQuery = "default-container-code";
document.getElementById("IframeShipsgoLiveMap").src =
"http://shipsgo.com/iframe/where-is-my-container/" +
defaultQuery + '?tags=hide-search-box';
</script>
Wichtiger Hinweis: Wenn Sie sowohl die Suchleiste als auch das Bewegungsfenster ausblenden möchten, können Sie dies tun. können Sie dies ebenfalls tun; wenden Sie einfach beide Lösungen in Ihrem Code an.
Wenn Sie das Bewegungsfenster in der Live Map-Lösung, die Sie auf Ihren Websites verwenden, deaktivieren möchten, können Sie die folgenden Codes verwenden.
<iframe
src="http://shipsgo.com/iframe/where-is-my-container/TEST1234567?movements=hide"
id="IframeShipsgoLiveMap"
style="height: 550px;width: 100%;"></iframe>
<script>
if (window.addEventListener)
window.addEventListener("message", ShipsgoMessagesListener);
function ShipsgoMessagesListener() {
if (event.data.Action === "LoadNewContainerCode")
document.getElementById("IframeShipsgoLiveMap").src =
"http://shipsgo.com/iframe/where-is-my-container/" +
event.data.Parameters.ContainerCode + '?movements=hide';
}
var urlParams = new URLSearchParams(window.location.search);
var defaultQuery = urlParams.get('query');
if (defaultQuery === undefined || defaultQuery === null)
defaultQuery = "default-container-code";
document.getElementById("IframeShipsgoLiveMap").src =
"http://shipsgo.com/iframe/where-is-my-container/" +
defaultQuery + '?movements=hide';
</script>
Wichtiger Hinweis: Wenn Sie sowohl die Suchleiste als auch das Bewegungsfenster ausblenden möchten, können Sie dies ebenfalls tun; wenden Sie einfach beide Lösungen in Ihrem Code an.
Wenn Sie das Bewegungsfenster und die Suchleiste auf der Live Map, die Sie auf Ihren Websites verwenden, deaktivieren möchten, können Sie die folgenden Codes verwenden.
<iframe
src="http://shipsgo.com/iframe/where-is-my-container/TEST1234567?movements=hide&tags
=hide-search-box" id="IframeShipsgoLiveMap"
style="height: 550px;width: 100%;"></iframe>
<script>
if (window.addEventListener)
window.addEventListener("message", ShipsgoMessagesListener);
function ShipsgoMessagesListener() {
if (event.data.Action === "LoadNewContainerCode")
document.getElementById("IframeShipsgoLiveMap").src =
"http://shipsgo.com/iframe/where-is-my-container/" +
event.data.Parameters.ContainerCode +
'?movements=hide&tags=hide-search-box';
}
var urlParams = new URLSearchParams(window.location.search);
var defaultQuery = urlParams.get('query');
if (defaultQuery === undefined || defaultQuery === null)
defaultQuery = "default-container-code";
document.getElementById("IframeShipsgoLiveMap").src =
"http://shipsgo.com/iframe/where-is-my-container/" +
defaultQuery + '?movements=hide&tags=hide-search-box';
</script>
Shipsgo
Sendungsverfolgungs-API
Dank des Shipsgo-API-Dienstes sind Ihr IT-System und unser Containerverfolgungsdienst nahtlos integriert.