Forniamo il servizio API
per il tracciamento dei container

Si prega di notare che:

Qualsiasi interazione con l'API richiederà sempre la tua CHIAVE API. Sarà disponibile sul cruscotto quando si dispone di un account. La nostra documentazione API può fornire informazioni più dettagliate sulla creazione di una nuova richiesta. L'API Shipsgo ha 2 metodi: Post e Get. Poiché alcune informazioni come {containerNumber}, {blContainersRef}, {emailAddress} ecc. sono necessari per avviare il monitoraggio, il primo passo è creare la richiesta di monitoraggio. La richiesta di tracciamento viene creata utilizzando il metodo Post con il contenitore, la polizza di carico principale o il numero di prenotazione. Il {requestId} restituisce con il "Codice di stato OK 200" ai client se la richiesta è stata creata e pubblicata su Shipsgo correttamente e ciò significa che la richiesta ha raggiunto il server.

Se il POST fallisce, ritorna il "Error Message". L'elenco delle risposte di errore per il metodo può essere trovato qui. 

Il client può eseguire il "metodo GET" per chiamare i dati di viaggio utilizzando {containerNumber} o {requestId} dopo che il messaggio di successo è stato restituito 

Si prega di tenere presente che il metodo POST è idempotente. È sufficiente eseguire POST per ogni traccia per una volta. Tuttavia, il client può effettuare chiamate GET quanto necessario. 

SUGGERIMENTO:

Dal momento che ogni spedizione viene aggiornato 3 volte al giorno per ogni spedizione 3 chiamate GET sono altamente sufficienti. 

Cautela:

L'API Shipsgo fornisce dati provenienti dal viaggio attivo o più recente di un container. 

Il tracciamento della "Hause Bill of Lading " non è supportato. Viene accettato solo il numero della polizza di carico principale.

È sufficiente eseguire POST per ogni traccia per una volta.

No, Dal momento che Shipsgo sta raccogliendo informazioni pubblicamente disponibili, l'autorizzazione non è necessaria. Puoi monitorare la tua spedizione in qualsiasi momento purché la tua linea di spedizione sia una delle linee di spedizione supportate e tu abbia una chiave API.

I dati del viaggio vengono aggiornati 3 volte al giorno. Quindi, puoi impostare la tua funzione GET in modo che venga attivata 3 volte al giorno.

Sì, forniamo API. Puoi trovare tutti i dettagli su API qui. Se hai bisogno di supporto tecnico o di ulteriori informazioni relative all'integrazione API, non esitare a scriverci dalla Live Chat o support@shipsgo.com.

Dopo aver creato il tuo account, avrai una chiave API. Puoi raggiungerlo attraverso la tua dashboard sotto la sezione Shipsgo Integration nella barra laterale sinistra. Puoi considerare questa chiave come un codice di comunicazione tra la tua azienda e Shipsgo. Grazie a questa chiave, quando il cliente invia la richiesta di tracciamento, il sistema Shipsgo riconosce il nome dell'azienda e memorizza la richiesta sull'account aziendale. Quindi, il nostro sistema invia l'e-mail di notifica a te e ai tuoi clienti con il tuo logo e l'indirizzo e-mail se lo desideri. Inoltre, utilizziamo questa chiave per calcolare anche il consumo dei tuoi crediti.

Certo che puoi. È sufficiente creare una funzione GET con API e aggiungere "&mapPoint=true" alla fine dellURL della richiesta. Poi vedrete le coordinate della nave.

No, non vi è alcuna limitazione per la pubblicazione di richieste di monitoraggio; o effettuare una chiamata per ottenere i dati di viaggio. Il limite di chiamata API è limitato solo all'importo del credito nei tuoi account. Puoi scoprire il nostro servizio API qui.

Quando utilizzi l'integrazione API, ottieni informazioni sul viaggio in formato XML o JSON. Una delle prime cose che vedrai nel file XML OR JSON è lo "status". Questo "status" indica lo stato delle spedizioni.

I significati degli stati sono i seguenti;

InProgress (StatusId = 20): la linea di spedizione non ha ancora rilasciato alcuna informazione sul container.

Booked (StatusId = 30): la compagnia di navigazione ha condiviso le informazioni sul viaggio relative a questa spedizione. Non è ancora salpato.

Loaded (StatusId = 35): la spedizione è caricata sulla nave ma la nave non è ancora salpata da POL.

Sailing (StatusId = 40): il container è in viaggio.

Arrived (StatusId = 45): la nave è arrivata al POD ma la spedizione è in attesa di essere scaricata

Discharged (StatusId = 50): il contenitore è stato scaricato alla porta di scarico.

Untracked (StatusId = 60): non è possibile tracciare il container perché la compagnia di navigazione responsabile del trasporto del container non dispone di un servizio di tracciamento online

Dopo che la tua richiesta di tracciamento ci ha raggiunto, il nostro sistema controlla il sito Web del vettore per compilare il modulo XML.

1. Se il tuo sistema chiama i dati prima che il sistema raccolga i dati dal sito Web del vettore, puoi avere una risposta dati vuota. Molto probabilmente, al secondo tentativo di chiamata, avrai i dati.

2. Se il vettore non fornisce ancora i dati del viaggio, la risposta XML sarà semplicemente vuota. Tuttavia, il nostro sistema controlla il sito Web del corriere 3 volte al giorno e riceve i dati quando è pronto. Quello che dovresti fare è impostare la tua chiamata GET in modo che venga eseguita 3 volte al giorno e, alla fine della giornata, avrai tutti i dati disponibili. Lo stato di questo tipo di dati è "In Progress".

3. A volte, tuttavia, le spedizioni non sono affatto tracciabili. Lo stato di questo tipo di spedizione è "Untracked". La spedizione può non essere tracciabile se la linea di spedizione non dispone di alcun sistema di tracciabilità o se il numero del contenitore non può essere assegnato a nessuna linea di spedizione.

Esempio di dati completi XML: https://drive.google.com/file/d/1_yHhrFHOMcBBjGUgWgAH53oxGoiNEZze/view?usp=sharing

Esempio di dati completi JSON: https://drive.google.com/file/d/167S4Ljoo_Op8u3J5k74c-_5In2hGUbOt/view?usp=sharing

Sfortunatamente, la nostra API attuale ti consente di interrogare ogni spedizione separatamente.

Per ottenere i dati da Shipsgo, inizialmente, devi inviare i dati al nostro sistema utilizzando la funzione POST della nostra API. Dopo il post, la tua richiesta dovrebbe pervenirci con successo. Quindi puoi estrarre i dati del viaggio con il metodo GET dell'API.

Se i tuoi dati ci raggiungono correttamente, viene restituito un ID richiesta come risposta. Questi ID sono univoci per ogni tua richiesta di tracciamento e differiscono da spedizione a spedizione. La funzione più importante di questo ID è che quando ottieni questo ID, sarai già sicuro che il tuo POST ci ha raggiunto con successo. È un messaggio di conferma da Shipsgo, per così dire.

Esempio di ID risposta riuscita 1-534567

Tuttavia, il tuo POST non è riuscito se ricevi le seguenti risposte invece di request-id. È necessario correggere i dati in base alle spiegazioni e inviare nuovamente la richiesta.

Risposta: "The Field (Code) Value (test1234) is not in a valid format"

Il numero del contenitore deve essere composto da 11 caratteri: 4 lettere seguite da 7 numeri EX. AAAA1234567

Risposta: "The Field (Code) Value (EGHU9483781) is not valid"

Il formato del numero del contenitore è vero, tuttavia il numero non è valido. Sarebbe EGHU948378-8 a causa delle regole di creazione del numero di contenitore

Risposta: "The shipping line field is required"

È necessario inserire il nome della linea di spedizione in base all'elenco delle linee di spedizione ShipsGo

Risposta: "The Entered Value (support@gmaıl.com) In Field (Email) Is Not A Valid Email Address"

Hai sbagliato a digitare l'indirizzo email. Si prega di controllare la digitazione

Risposta: "No Active Subscription Or It Is Expire"

Probabilmente i tuoi crediti si sono esauriti o il tuo account era inattivo per qualche altro motivo. Si prega di contattare il team Shipsgo quando è successo

Dopo aver completato correttamente il POST, puoi eseguire il metodo GET seguendo le regole. Potresti incontrare alcuni messaggi di errore durante l'esecuzione di GET. Eccoli e il loro significato:

Messaggio di errore: "Invalid Authentication Code"

Stai utilizzando una chiave API non valida o il tuo account non può utilizzare la connessione API

Messaggio di errore: "No Active Subscription Or It Is Expire"

Probabilmente i tuoi crediti si sono esauriti o il tuo account era inattivo per qualche altro motivo.

Messaggio di errore: "There Are No Data Related To Requested Id"

Stai inserendo il numero del container/ID della richiesta errato. Oppure cerchi di ottenere i dati del container di cui non ci hai POST la richiesta di tracciamento.

Puoi trovare tutti i dettagli sulle pietre miliari qui.

No. L'unica cosa che devi fare è inviare il numero BL. Il sistema attiverà i container sotto il BL con i dati di viaggio e li renderà pronti in XML/JSON.

Ogni spedizione viene aggiornata ogni 8 ore dopo l'ora di creazione, quindi il tempo di aggiornamento varia da spedizione a spedizione in base all'ora di creazione. Tuttavia, puoi impostare la funzione GET 3 volte al giorno mattina, mezzogiorno e sera. Quindi, alla fine della giornata, avrai tutti gli aggiornamenti per tutte le tue spedizioni

Quando pubblichi la spedizione su Shipsgo, ricevi un ID richiesta se il POST va a buon fine. Dopo aver ottenuto l'ID richiesta, puoi effettuare una chiamata immediatamente. Avrai una risposta. Tuttavia, i dati potrebbero non essere disponibili in quel momento e il file XML potrebbe essere nullo perché la disponibilità dei dati è a carico del vettore. Se i dati sono disponibili sul sito Web dell'operatore, il tempo medio di risposta è in secondi.

Se desiderate disattivare la barra di ricerca della soluzione Live Map che state utilizzando sui vostri siti web, potete utilizzare i codici iframe riportati di seguito.

<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>

Nota importante: se si desidera nascondere sia la barra di ricerca che la finestra dei movimenti, è possibile farlo; basta applicare entrambe le soluzioni al codice.

Se desiderate disattivare la finestra dei movimenti sulla soluzione Live Map che state utilizzando sui vostri siti web, potete utilizzare i codici seguenti.

<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>

Nota importante: se si desidera nascondere sia la barra di ricerca che la finestra dei movimenti, è possibile farlo; basta applicare entrambe le soluzioni al codice.

Se volete disattivare la finestra dei movimenti e la barra di ricerca che si trovano sulla Live Map che state utilizzando sui vostri siti web, potete utilizzare i codici seguenti.

<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>