Oferecemos serviço de API
para rastreamento de contêineres
Aqui estão as informações que você obtém da
API de Rastreamento Shipsgo
Qualquer interação com a API sempre exigirá uma CHAVE de API. Ele estará disponível em seu painel quando você tiver uma conta.
Nossa documentação de API pode fornecer informações mais detalhadas sobre como criar uma nova solicitação. A API Shipsgo possui 2 métodos: POST e GET
Como algumas informações como {containerNumber}, {blContainersRef} , {emailAddress} etc. são necessárias para iniciar o rastreamento, a primeira etapa é criar a solicitação de rastreamento. A solicitação de rastreamento é criada usando o Post Method com o contêiner, conhecimento de embarque mestre ou número de reserva. O {requestId} retorna com o código de status 200 OK para os clientes se a solicitação foi criada e enviada ao Shipsgo com sucesso e isso significa que a solicitação chegou ao servidor. Se o POST falhar, a Mensagem de Erro retorna. A lista das respostas de erro para o método pode ser encontrada aqui.
O cliente pode executar o método GET para chamar os dados da viagem usando {containerNumber} ou {requestId} após a mensagem de sucesso retornada
Basta executar o método POST para cada faixa uma vez. No entanto, o cliente pode fazer chamadas GET quantas vezes for necessário.
Dica:
Como cada remessa é atualizada 3 vezes ao dia para cada remessa, 3 chamadas GET seriam suficientes.
Cuidado:
A API Shipsgo fornece dados provenientes da viagem ativa ou mais recente de um contêiner.
O rastreamento do conhecimento de embarque doméstico não é suportado. Somente o número do conhecimento de embarque mestre é aceito.
Basta executar o POST para cada faixa uma vez.
Não, como o Shipsgo está coletando informações publicamente disponíveis, a letra de autorização não é necessária. Você pode rastrear sua remessa a qualquer momento, desde que sua contêineres transportadora seja uma das transportadoras de contêineres suportadas e você tenha uma chave de API.
Os dados da viagem são atualizados 3 vezes ao dia. Assim, você pode configurar sua função GET para ser provocado 3 vezes ao dia.
Sim, nós fornecemos API. Você pode encontrar todos os detalhes sobre a API aqui.
Se você precisar de suporte técnico ou mais informações relacionadas à integração da API, entre em contato conosco pelo chat ao vivo ou support@shipsgo.com.
Depois de criar sua conta, você terá uma chave de API. Você pode acessá-lo através do seu painel na seção INTEGRAÇÃO na barra lateral esquerda. Você pode considerar esta chave como um código de comunicação entre sua empresa e a Shipsgo. Graças a esta chave, quando o cliente envia a solicitação de rastreamento, o sistema Shipsgo reconhece o nome da empresa e armazena a solicitação na conta da empresa. Em seguida, nosso sistema envia o e-mail de notificação para você e seus clientes com seu logotipo e endereço de e-mail, se desejar. Além disso, usamos esta Chave para calcular o consumo de seus créditos também.
Não, não há limitação para postagem de solicitações de rastreamento; ou fazer uma chamada para obter dados de viagem. Seu limite de chamadas de API é restrito apenas ao valor do créditos em suas contas. Você pode descobrir nosso serviço de API aqui. Você não paga para obter dados de viagem, ou seja, para várias chamadas de API.
Claro que você pode. Basta criar uma função GET com API e adicionar "&mapPoint=true" ao final da URL da requisição. Então você verá as coordenadas da embarcação.
Ao usar a integração da API, você obtém informações de viagem em um formato XML ou JSON. Uma das primeiras coisas que você verá no arquivo XML ou JSON é o "status". Este "status" indica a condição das remessas.
Os significados dos status são os seguintes;
InProgress (StatusId = 20): A transportadora ainda não divulgou nenhuma informação sobre o contêiner.
Booked (StatusId = 30): a transportadora de remessa compartilhou as informações de viagem sobre esta remessa. Ainda não foi navegou.
Loaded (StatusId = 35): A remessa está carregada na embarcação, mas a embarcação ainda não saiu do porta de carregamento (POL).
Sailing (StatusId = 40): O contêiner está a caminho.
Arrived (StatusId = 45): A Embarcação chegou ao porta de descarga (POD), mas A remessa está aguardando para ser descarregada
Discharged (StatusId = 50): O contêiner foi descarregado na porta de descarga.
Untracked (StatusId = 60): Não é possível rastrear o container porque a transportadora responsável pelo remessa do container não possui serviço de rastreamento online.
Você pode encontrar todos os detalhes sobre os termos aqui.
Não, a única coisa que você precisa fazer é enviar o número do BL. O sistema vai acionar os containers sob o BL com os dados da viagem e deixar pronto em XML/JSON.
Cada remessa é atualizada a cada 8 horas após o horário de criação, portanto, o tempo de atualização difere de remessa para remessa de acordo com o horário de criação. No entanto, você pode definir sua função GET 3 vezes ao dia, de manhã, ao meio-dia e à noite. Então, no final do dia, você terá todas as atualizações para todas as suas remessas
Ao postar a remessa no Shipsgo, você obtém um ID de solicitação se o POST for bem-sucedido. Depois de obter o ID da solicitação, você pode fazer uma API call imediatamente. Você terá uma resposta. No entanto, os dados podem não estar disponíveis naquele momento e o arquivo XML pode ser nulo porque a disponibilidade dos dados fica por conta da transportodor. Se os dados estiverem disponíveis no site da transportodor, o tempo médio de resposta é em segundos.
Infelizmente, nossa API atual permite que você consulte cada remessa separadamente.
Depois que sua solicitação de rastreamento chega até nós, nosso sistema verifica o site da operadora para preencher o formulário XML.
1. Se o seu sistema chamar os dados antes de coletar os dados do site da operadora, você poderá ter uma resposta de dados vazia. Muito provavelmente, na segunda tentativa de chamada, você terá os dados.
2. Se a transportador ainda não fornecer os dados da viagem, a resposta XML simplesmente estará vazia. No entanto, nosso sistema verifica o site a transportador 3 vezes ao dia e obtém os dados quando estiver pronto. O que você deve fazer é configurar sua chamada GET para executar 3 vezes ao dia e, no final do dia, você terá todos os dados disponíveis. O status desse tipo de dado é "in progress".
3. Às vezes, as remessas não são rastreáveis. O status desse tipo de remessa é "untracked". A remessa pode não ser rastreável a transpotador de remessa não tiver nenhum sistema de rastreamento ou o número do contêiner não puder ser atribuído a nenhuma a transpotador.
Para obter dados do Shipsgo, inicialmente, você deve enviar dados para nosso sistema usando a função POST da API. Após a postagem, sua solicitação deve chegar até nós com sucesso. Em seguida, você pode extrair os dados da viagem pelo método GET da API.
Se seus dados chegarem até nós com sucesso, um ID de solicitação retornará como resposta. Esses IDs são exclusivos para cada solicitação de rastreamento sua e diferem de remessa para remessa. A função mais importante desse ID é que ao obter esse ID, você já terá a certeza de que seu POST chegou até nós com sucesso. É uma mensagem de confirmação do Shipsgo.
Exemplo de ID de resposta bem-sucedida: 1-534567
No entanto, seu POST falhou se você obtiver as seguintes respostas em vez de ID de solicitação (request-id). Você precisa corrigir os dados de acordo com as explicações e postar a solicitação novamente.
Resposta: "O valor do campo (código) (test1234) não está em um formato válido"
- O número do contêiner deve consistir em 11 caracteres: 4 letras seguidas por 7 números EX. AAAA1234567
Resposta: "O valor do campo (código) (EGHU9483781) não é válido"
- O formato do número do contêiner é verdadeiro, mas o número não é válido. Seria EGHU948378-8 devido às regras de criação do número do contêiner.
Resposta: "O campo a transportador de remessa é obrigatório"
- Você precisa inserir o nome a transportador de remessa de acordo com a lista de linhas de remessa Shipsgo
Resposta: "O valor inserido (support@gmail.com) no campo (e-mail) não é um endereço de e-mail válido"
- Você digitou o endereço de e-mail errado. Por favor, controle a digitação
Resposta: "Nenhuma assinatura ativa ou expirado"
- Provavelmente seus créditos acabaram ou sua conta ficou inativa por algum outro motivo. Entre em contato com a equipe Shipsgo quando isso acontecer
Depois de concluir o POST com sucesso, você pode executar o método GET seguindo as regras. Você pode encontrar algumas mensagens de erro ao executar o GET. Aqui estão eles e seus significados:
Mensagem de erro: "Código de autenticação inválido"
- Você está usando uma chave de API inválida ou sua conta está proibida de usar a conexão de API
Mensagem de erro: "Nenhuma assinatura ativa ou expirado"
- Provavelmente seus créditos acabaram ou sua conta ficou inativa por algum outro motivo.
Mensagem de erro: "Não há dados relacionados ao ID solicitado"
- Você está inserindo o número do contêiner/ID da solicitação (request-id) errado. Ou você tenta obter os dados do contêiner do que você não postou a solicitação de rastreamento para nós.
Se você quiser desativar a barra de pesquisa na solução Live Map que está usando em seus sites, poderá usar os códigos de iframe abaixo.
<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>
Observação importante: se quiser ocultar a barra de pesquisa e a janela de movimentos, você também pode fazer isso. também poderá fazer isso; basta aplicar as duas soluções ao seu código.
Se quiser desativar a janela de movimentos na solução Live Map que você está usando em seus sites, use os códigos abaixo.
<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>
Observação importante: se quiser ocultar a barra de pesquisa e a janela de movimentos, você também pode fazer isso; basta aplicar as duas soluções ao seu código.
Se pretender desativar a janela de movimentos e a barra de pesquisa que se encontram no Mapa em direto que está a utilizar nos seus sítios Web, pode utilizar os códigos abaixo.
<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>
Serviço
API de Shipsgo
Graças ao serviço API Shipsgo, seu sistema de TI e nosso serviço de rastreamento de contêineres são integrados de forma suave.