Konteyner takibi için
API çözümleri Sağlıyoruz
İşte Shipsgo Konteyner Takip API'sinin
size sağladığı taşıma bilgileri
Lütfen aşağıdaki adımları uygulayın:
API ile herhangi bir etkileşim için her zaman API ANAHTARI gereklidir. Bir Shipsgo hesabı oluşturduğunuzda, kontrol panelinizde API anahtarına ulaşabilirsiniz.
API dökümanlarımız, yeni bir takip talebi oluşturmanız hakkında daha ayrıntılı bilgi sağlayabilir. Talep başarılı bir şekilde oluşturulduysa ve Shipsgo'ya gönderildiyse, {requestId} istemcilere 200 OK Durum Kodu ile döner ve bu, talebin sunucuya ulaştığı anlamına gelir. POST başarısız olursa, bir hata mesajı döner. Yöntem için hata yanıtlarının listesine buradan ulaşabilirsiniz. İstemci, başarı yanıtı aldıktan sonra {containerNumber} veya {requestId} kullanarak yük sefer verilerini çağırmak için GET yöntemini çalıştırabilir. Her takip talebi için bir defa POST çalıştırmanız yeterlidir. Ancak istemci ihtiyaç duyduğu kadar GET çağrısı yapabilir.
İpucu:
Her talep günde 3 kez güncellendiğinden, her talep için 3 GET çağrısı yeterlidir.
Dikkat:
Shipsgo API'si, bir konteynerin aktif veya en son yolculuğundan elde edilen verileri sunar.
Shipsgo ara konşimento numara takibi desteklememektedir. Sadece ana konşimento numarası kabul edilir.
Her takip için bir defa POST çalıştırmanız yeterlidir.
Sefer verileri günde 3 kez güncellenmektedir. GET fonksiyonunuzu günde 3 defa tetiklenecek şekilde ayarlayabilirsiniz.
Evet, API hizmeti sağlamaktayız. API ile ilgili tüm detayları burada bulabilirsiniz. Teknik destek ve API entegrasyonuyla ilgili daha fazla bilgi için, canlı desteğe yazabilir veya support@shipsgo.com adresinden bize ulaşabilirsiniz.
Shipsgo hesabınızı oluşturduktan sonra kontrol panelinizin sol kenar çubuğundaki ENTEGRASYON bölümünden API anahtarınıza ulaşabilirsiniz. Bu anahtarı, şirketiniz ile Shipsgo arasında bir iletişim kodu olarak düşünebilirsiniz. API anahtarı sayesinde müşterileriniz konteyner takip talebi gönderdiğinde Shipsgo sistemi firma adını tanır ve talebi firma hesabına kaydeder. Daha sonra sistemimiz size ve müşterilerinize dilerseniz logonuz ve e-posta adresiniz ile bilgilendirme e-postasını gönderir. Ayrıca, bu anahtar kredi tüketiminizin hesaplanması için de kullanılmaktadır.
Hayır, takip isteği göndermek veya sefer verilerini almak için herhangi bir sınırlama yoktur. API çağrı limitiniz sadece hesabınızdaki kredi miktarı ile sınırlıdır. Kredileriniz sadece yükünüzü sisteme POST ettiğinzde tüketilecektir. Birden fazla API çağrısı için ödeme yapmazsınız.
Hayır. Shipsgo halka açık bilgileri toplamaktadır, bu sebeple yetkilendirme gerekli değildir. Armatörünüz, Shipsgo'nun desteklediği armatörlerden biriyse ve bir API anahtarınız varsa, yüklerinizi istediğiniz zaman takip edebilirsiniz.
API ile bir GET fonksiyonu oluşturmanız ve istek URL'sinin sonuna "&mapPoint=true" eklemeniz yeterlidir. Ardından canlı bir harita üzerinde geminin konumunu gösteren yeni bir pencerenin açıldığını göreceksiniz.
API entegrasyonu kullandığınızda, sefer bilgilerini XML veya JSON formatında alırsınız. XML veya JSON dosyasında göreceğiniz ilk şeylerden biri "status" dur. Bu "status" yüklerinizin durumunu gösterir.
Statülerin anlamları şu şekildedir:
InProgress (StatusId = 20): Armatör, konteyner hakkında henüz herhangi bir bilgi paylaşmadı.
Booked (StatusId = 30): Armatör, bu taşımayla ilgili sefer bilgilerini paylaştı. Gemi henüz denize açılmadı.
Loaded (StatusId = 35): Konteyner gemiye yüklendi ancak gemi henüz yükleme limanından yola çıkmadı.
Sailing (StatusId = 40): Konteyner yolda.
Arrived (StatusId = 45): Gemi boşaltma limanına ulaştı ancak sevkiyat boşaltılmayı bekliyor.
Discharged (StatusId = 50): Konteyner boşaltma limanında boşaltıldı edildi.
Untracked (StatusId = 60): Konteyneri taşımakla yükümlü armatörün online takip hizmeti olmadığı için konteynerin takibi yapılamadı.
Takip talebiniz bize ulaştıktan sonra sistemimiz, XML formunu doldurmak için armatör web sitesini kontrol eder
1. Sisteminiz verileri armatörün web sitesinden toplamadan önce ararsa, boş bir veri yanıtı alabilirsiniz. Büyük olasılıkla, ikinci arama girişiminde verileri almış olacaksınız.
2. Armatör henüz sefer verilerini sağlamamışsa, XML yanıtı boş olacaktır. Ancak sistemimiz günde 3 kez armatörün web sitesini kontrol eder ve hazır olduğunda verileri alır. Yapmanız gereken, GET çağrınızı günde 3 kez çalışacak şekilde ayarlamaktır, böylece günün sonunda tüm verilere sahip olabilirsiniz. Bu tür verilerin durumu "in progsess" olarak görünür.
3. Ancak bazen takip talepleri sistemimiz tarafından izlenemez. Bu tür yüklere "untracked" denmektedir. Armatörün konteyner takip sistemi mevcut değilse veya konteyner numarası herhangi bir armatörle ilişkilendirilemiyorsa, yük takip edilemez "untracked" olabilir.
Mevcut API'miz her yükü ayrı ayrı sorgulamanıza izin vermektedir.
Shipsgo'dan veri almak için öncelikle API POST fonksiyonunu kullanarak sistemimize veri göndermelisiniz. Gönderdikden sonra, talebiniz başarıyla bize ulaşacaktır. Ardından, sefer verilerini API'nin GET yöntemiyle çekebilirsiniz.
Talebiniz bize başarılı bir şekilde ulaşınca, yanıt olarak bir talep ID'si atanır. Bu ID'ler, her takip talebiniz için benzersizdir ve yükten yüke farklılık gösterir. Bu ID'ler, POST'unuzun bize başarılı bir şekilde ulaştığını anlamına gelir. Bunu, Shipsgo'dan gelen bir onay mesajı olarak düşünebilirsiniz.
Başarılı yanıt ID örneği: 1-534567
Ancak, talep ID (request-id) yerine aşağıdaki yanıtları almanız POST'unuzun başarısız olduğu anlamına gelir ve verileri açıklamalara göre düzeltmeniz ve talebi tekrar göndermeniz gerekir.
Yanıt: "The Field (Code) Value (test1234) is not in a valid format"
Container number must consist of 11 characters: 4 letters followed By 7 Numbers EX. AAAA1234567
Yanıt: "The Field (Code) Value (EGHU9483781) is not valid"
Konteyner numarasının biçimi doğrudur, ancak sayı geçerli değildir. Konteyner numarası oluşturma kuralları nedeniyle EGHU948378-8 olmalıdır.
Yanıt: "The shipping line field is required"
Shipsgo'nun desteklediği armatör listesine göre bir armatör adı girmeniz gerekmektedir.
Yanıt: "The Entered Value (support@gmaıl.com) In Field (Email) Is Not A Valid Email Address"
E-posta adresinizi yanlış yazdığınız anlamına gelir. Lütfen e-posta adresinizi kontrol ediniz.
Yanıt: "No Active Subscription Or It Is Expire"
Kredilerinizin tükendiği anlamına gelir veya farklı bir sebepten dolayı hesabınız aktif değildir.
Lütfen bu durumda Shipsgo ekibi ile iletişime geçin.
POST işlemini başarıyla tamamladıktan sonra kurallara uyarak GET yöntemini çalıştırabilirsiniz. GET'i çalıştırırken bazı hata mesajlarıyla karşılaşabilirsiniz. İşte bazı hata yanıtları ve anlamları:
Hata:"Invalid Authentication Code"
Geçersiz bir API ANAHTARI kullanıyorsunuz veya hesabınızın API bağlantısını kullanması yasak.
Hata: "No Active Subscription Or It Is Expire"
Kredilerinizin bittiği veya farklı bir sebepten dolayı hesabınızın aktif olmadığı anlamına gelir.
Hata: "There Are No Data Related To the Requested Id"
Yanlış konteyner numarası/talep ID'si giriyorsunuz. Veya takip talebini bize POST olarak göndermediğiniz konteyner verilerini almaya çalışıyorsunuz.
API terimleriyle ilgili tüm detayları burada bulabilirsiniz.
Her yük, talep oluşturma zamanından sonra her 8 saatte bir güncellenir, bu nedenle güncelleme zamanı, oluşturma zamanına göre yükten yüke farklılık gösterebilir. Ancak GET fonksiyonunuzu sabah, öğle ve akşam olmak üzere günde 3 sefere ayarlayabilirsiniz. Böylece günün sonunda, tüm gönderileriniz için tüm güncellemelere sahip olabilirsiniz.
Takip talebini Shipsgo'ya gönderdiğinizde, bir talep ID'si oluşur. Talep ID'sini aldıktan sonra çağrı yapabilirsiniz. Çağrı cevaplanacaktır. Ancak, veriler o anda mevcut olmayabilir ve veri kullanılabilirliği armatöre bağlı olduğundan XML dosyası boş olabilir. Veriler armatörün web sitesinde mevcutsa, ortalama yanıt süresi saniye cinsindendir.
Arama çubuğunu devre dışı bırakmak istiyorsanız web siteleriniz için aşağıdaki iframe kodlarını kullanabilirsiniz.
<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>
Önemli Not: Hem arama çubuğunu hem de hareketler penceresini gizlemek istiyorsanız, her iki çözümü de kodunuza uygulamanız yeterlidir.
Web sitelerinizde kullandığınız Live Map'te hareketler penceresini devre dışı bırakmak istiyorsanız aşağıdaki kodları kullanabilirsiniz.
<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>
Önemli Not: Hem arama çubuğunu hem de hareketler penceresini gizlemek istiyorsanız; her iki çözümü de kodunuza uygulamanız yeterlidir.
Web sitelerinizde kullandığınız Live Map çözümünde yer alan hareketler penceresini ve arama çubuğunu devre dışı bırakmak istiyorsanız aşağıdaki kodları kullanabilirsiniz.
<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
API Hizmeti
Shipsgo API Hizmeti sayesinde, BT sisteminiz ve konteyner takip hizmetimiz sorunsuz bir şekilde entegre olacaktır.