Nous fournissons un service API
pour le suivi des conteneurs

Toute interaction avec l'API nécessitera toujours votre clé API. Il sera disponible sur votre tableau de bord lorsque vous aurez un compte.

Notre documentation API peut fournir des informations plus détaillées sur la création d'une nouvelle demande.

L'API Shipsgo a 2 méthodes : Post et Get.

Étant donné que certaines informations telles que {containerNumber}, {blContainersRef} , {emailAddress} etc. sont nécessaires pour démarrer le suivi, la première étape consiste à créer la demande de suivi. La demande de suivi est créée à l'aide de la méthode Post avec le conteneur, le connaissement Master (MBL) ou le numéro de réservation.

Le {requestId} revient avec le code d'état 200 OK aux clients si la demande a été créée et publiée avec succès sur Shipsgo, ce qui signifie que la demande a atteint le serveur.

Si le POST échoue, le message d'erreur revient. La liste des réponses d'erreur pour la méthode peut être trouvée ici.

Le client peut exécuter la méthode GET pour appeler les données de voyage en utilisant {containerNumber} ou {requestId} après le message de réussite renvoyé.

Il suffit d'exécuter POST pour chaque piste pour une fois. Cependant, le client peut effectuer autant d'appels GET que nécessaire.

Conseil:

• Étant donné que chaque expédition est mise à jour 3 fois par jour pour chaque expédition, 3 appels GET sont largement suffisants.

Avertir:

• L'API Shipsgo fournit des données provenant le voyage actif ou le plus récent d'un conteneur.
• Le suivi du connaissement House (HBL) n'est pas pris en charge. Seul le numéro de connaissement Master (MBL) est accepté.
• Il suffit d'exécuter POST pour chaque piste pour une fois.

Non, puisque Shipsgo recueille des informations accessibles au public, la lettre d'autorisation n'est pas nécessaire. Vous pouvez suivre votre envoi à tout moment tant que votre compagnie maritime est l'une des compagnies maritimes prises en charge et que vous disposez d'une clé API.

Les données du voyage sont mises à jour 3 fois par jour. Ainsi, vous pouvez paramétrer votre fonction GET pour qu'elle se déclenche 3 fois par jour.

Oui, nous fournissons API. Vous pouvez trouver tous les détails sur l'API ici. Si vous avez besoin d'une assistance technique ou de plus d'informations sur l'intégration de l'API, n'hésitez pas à nous écrire à partir du chat en direct ou à support@shipsgo.com.

Après avoir créé votre compte, vous allez avoir une clé API. Vous pouvez y accéder via votre tableau de bord sous la section INTÉGRATION dans la barre latérale gauche. Vous pouvez considérer cette clé comme un code de communication entre votre entreprise et Shipsgo. Grâce à cette clé, lorsque le client envoie la demande de suivi, le système Shipsgo reconnaît le nom de l'entreprise et enregistre la demande sur le compte de l'entreprise. Ensuite, notre système vous envoie l'e-mail de notification ainsi qu'à vos clients avec votre logo et votre adresse e-mail si vous le souhaitez. En outre, nous utilisons également cette clé pour calculer la consommation de vos crédits.

Non, il n'y a aucune limitation pour publier des demandes de suivi ; ou passer un d'appels API pour obtenir des données de voyage. Votre limite d'appels API est uniquement limitée au montant du crédit dans vos comptes. Vous pouvez découvrir notre service API ici.

Bien sûr vous pouvez.

Il suffit de créer une fonction GET avec API et d'ajouter "&mapPoint=true" à la fin de l'URL de la requête. Ensuite, vous verrez les coordonnées du navire.

Lorsque vous utilisez l'intégration de l'API, vous obtenez des informations sur le voyage au format XML ou JSON. L'une des premières choses que vous verrez dans le fichier XML OU JSON est le "statut". Ce "statut" indique l'état des envois .

Les significations des statuts sont les suivantes ;

InProgress (StatusId = 20): La armeteur n'a pas encore publié d'informations sur le conteneur.

Booked (StatusId = 30): La armeteur a partagé les informations de voyage concernant cet envoi. Il n'est pas encore navigué.

Loaded (StatusId = 35): L'envoi est chargé sur le navire mais le navire n'a pas encore quitté le port de chargement (POL).

Sailing (StatusId = 40): Le conteneur est en route.

Arrived (StatusId = 45): Le navire est arrivé au port de déchargement (POD) mais la cargaison attend d'être déchargée

Discharged (StatusId = 50): Le conteneur a été déchargé au port de déchargement.

Untracked (StatusId = 60): Il n'est pas possible de suivre le conteneur car la compagnie maritime responsable du transport du conteneur n'a pas de service de suivi en ligne.

Une fois que votre demande de suivi nous est parvenue, notre système vérifie le site web du armeteur pour remplir le formulaire XML.

1. Si votre système appelle les données avant que le système ne collecte les données du site Web de armeteur, vous pouvez avoir une réponse de données vide. Très probablement, à la deuxième tentative d'appel, vous aurez les données.

2. Si l'armateur ne fournit pas encore les données de voyage, la réponse XML sera tout simplement vide. Cependant, notre système vérifie le site web l'armateur 3 fois par jour et obtient les données lorsqu'elles sont prêtes. Ce que vous devez faire est de configurer votre appel GET pour qu'il s'exécute 3 fois par jour, et à la fin de la journée, vous aurez toutes les données disponibles. Le statut de ce type de données est "in progress".

3. Parfois, cependant, les envois ne sont pas du tout traçables. Le statut de ce type d'envoi est "untracked". L'envoi peut être impossible à suivre si l'armateur n'a aucun système de suivi ou si le numéro de conteneur ne peut être attribué à aucune compagnie maritime.

Exemple de données complètes XML

Exemple de données complètes JSON

Notre API actuelle vous permet d'interroger chaque envoi séparément.

Afin d'obtenir des données de Shipsgo, vous devez d'abord envoyer des données à notre système en utilisant la fonction POST de notre API. Après la poste, votre demande devrait nous parvenir avec succès. Ensuite, vous pouvez tirer les données de voyage par la méthode GET de l'API.

Si vos données nous parviennent avec succès, un request ID est renvoyé en réponse. Ces identifiants sont uniques pour chacune de vos demandes de suivi et diffèrent d'un envoi à l'autre. La fonction la plus importante de cet ID est que lorsque vous obtenez cet ID, vous serez déjà sûr que votre POST nous est parvenu avec succès. C'est un message de confirmation de Shipsgo.

Exemple de réponse réussie ID: 1-534567

Cependant, votre POST a échoué si vous obtenez les réponses suivantes au lieu de request ID. Vous devez corriger les données en fonction des explications et poster à nouveau la demande.

Réponse: "La valeur du champ (code) (test1234) n'est pas dans un format valide"

• Le numéro de conteneur doit être composé de 11 caractères : 4 lettres suivies de 7 chiffres EX. AAAA1234567

Réponse: "La valeur du champ (code) (EGHU9483781) n'est pas valide"

• Le format du numéro de conteneur est vrai, mais le numéro n'est pas valide. Ce serait EGHU948378-8 en raison des règles de création du numéro de conteneur.

Réponse: "Le champ de la ligne d'expédition est obligatoire"

• Vous devez entrer le nom de la compagnie maritime selon la liste des compagnies maritimes Shipsgo.

Réponse : "La valeur saisie (support@gmail.com) dans le champ (E-mail) n'est pas une adresse e-mail valide"

• Vous avez mal saisi l'adresse e-mail. Veuillez contrôler la saisie

Réponse : "Aucun abonnement actif ou il a expire"

• Vos crédits ont probablement été épuisés ou votre compte était inactif pour une autre raison. Veuillez contacter l'équipe Shipsgo lorsque cela se produit.

Après avoir terminé le POST avec succès, vous pouvez exécuter la méthode GET en suivant les règles. Vous pouvez rencontrer des messages d'erreur lors de l'exécution du GET. Les voici et leur signification :

Message d'erreur: "Code d'authentification non valide"

• Vous utilisez une clé API invalide ou votre compte n'est pas autorisé à utiliser la connexion API.

Message d'erreur: "Aucun abonnement actif ou il a expire"

• Vos crédits ont probablement été épuisés ou votre compte était inactif pour une autre raison.

Message d'erreur: "Il n'y a pas de données liées à l'identifiant demandé"

• Vous entrez le mauvais numéro de conteneur/request ID. Ou vous essayez d'obtenir les données du conteneur dont vous ne nous avez pas POSTÉ la demande de suivi"

Vous pouvez trouver tous les détails sur les termes de l'API ici.

Non. La seule chose que vous devez faire est d'envoyer le numéro BL. Le système va déclencher les conteneurs sous le BL avec les données de voyage et les préparer en XML/JSON.

Chaque expédition est mise à jour toutes les 8 heures après l'heure de création, de sorte que l'heure de mise à jour diffère d'une expédition à l'autre en fonction de l'heure de création. Cependant, vous pouvez paramétrer votre fonction GET 3 fois par jour matin, midi et soir. Ainsi, à la fin de la journée, vous aurez toutes les mises à jour pour toutes vos expéditions.

Lorsque vous publiez l'envoi sur Shipsgo, vous obtenez un request ID si le POST est réussi. Après avoir obtenu request ID, vous pouvez passer un appel immédiatement. Vous aurez une réponse. Cependant, les données peuvent ne pas être disponibles à ce moment et le fichier XML peut être nul car la disponibilité des données dépend l'armateur. Si les données sont disponibles sur le site web l'armateur, le temps de réponse moyen est en secondes.

Si vous souhaitez désactiver la barre de recherche sur la solution Live Map que vous utilisez sur vos sites web, vous pouvez utiliser les codes iframe ci-dessous. sur vos sites web, vous pouvez utiliser les codes iframe ci-dessous.

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

Remarque importante: si vous souhaitez masquer à la fois la barre de recherche et la fenêtre des mouvements, vous pouvez le faire également. vous pouvez le faire également ; il vous suffit d'appliquer les deux solutions à votre code.

Si vous souhaitez désactiver la fenêtre des mouvements sur la solution Live Map que vous utilisez sur vos sites web, vous pouvez utiliser les codes ci-dessous.

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

Note importante: Si vous souhaitez masquer à la fois la barre de recherche et la fenêtre des mouvements, vous pouvez le faire également ; il suffit d'appliquer les deux solutions à votre code.

Si vous souhaitez désactiver la fenêtre des mouvements et la barre de recherche qui se trouvent sur la solution Live Map que vous utilisez sur vos sites web, vous pouvez utiliser les codes ci-dessous.

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