EasyCargo API Rehberi (2. bölüm)

Yazının ilk bölümünde bahsettiğimiz gibi, bugün EasyCargo API’sine daha çok pratik yönden “yaklaşacağız”. Bunun için API istemcimizi kullanacağız. Ayrıca ReqBin çevrimiçi aracını kullanarak API’nin çalışmasını test edeceğiz. Bu araç, EasyCargo konteyner yükleme hesaplayıcımızdan ilgilendiğimiz verileri indirebileceğimiz bir WWW sunucusuyla iletişim kurmamızı sağlar. Test etmek bir şeydir, ancak gerçek hayatta, yazılımınız için bir Java eklentisi veya SAP’den Javascript çağrıları kullanıyor olabilirsiniz. Bu konuda daha fazla bilgi, Make platformu ve diğer gerçek dünya API kullanım durumları bu serinin bir sonraki yazısında.

Yukarıdaki talebin ReqBin aracında nasıl göründüğüne bakın.

Yukarıdaki resim EasyCargo için API istemcimizi göstermektedir. Web sunucusuna herhangi bir API isteği gönderebilmek için önce istemcinin yetkilendirilmesi gerekir. Bu nedenle başlangıç isteği, içeriğinde kullanıcı adı ve API anahtarı bulunan bir POST http://go.easycargo3d.com/api/v1/authentication şeklindedir. Yanıt olarak sunucudan bir kimlik doğrulama belirteci alırsınız. Sonraki her API isteği (aksi belirtilmedikçe), elde edilen belirteci başlığına ekleyerek doğrulanmalıdır. Burada yapılan tüm API isteklerinin belirteç sahibi adına yapıldığını belirtmekte fayda var. İstekler ve yanıtlar JSON veya XML formatında oluşturulmalıdır.

Kimliğimiz doğrulandığına göre, şimdi API’nin daha ilginç ve eğlenceli kısmına geçelim. X kullanıcısının hesabında aşağıdaki kargo yüklerinin kayıtlı olduğunu varsayalım.

API isteklerini onlar üzerinde uygulayacağız çünkü nakliye yükleri muhtemelen EasyCargo’nun en önemli parçasıdır. Kullanıcı yönetimi gibi diğer talepler de benzer şekilde formüle edilmiştir, bu nedenle bu makalenin her okuyucusunun diğer taleplerin oluşturulmasını idare edebileceğine inanıyoruz. EasyCargo için API dokümantasyonumuzda, programlama arayüzünün her yöntemi açıklanmış ve açıklanmıştır.

Herhangi bir şüpheniz varsa, lütfen support@easycargo3d.com adresinden bizimle iletişime geçin veya iletişim formumuzu kullanın.

Gönderiler Hakkında API İstekleri

API dokümantasyonunun bize bildirdiği gibi, doğru şekilde ifade edilmiş taleplerle, sunucudan tüm nakliye yüklerinin bir listesini ve EasyCargo hesabından belirli bir yük hakkında veri alabiliriz. Hatta hesaptan bir yük oluşturabilir veya silebiliriz.

Tüm Gönderilerin Listesini Alma

Yukarıdaki talebin ReqBin aracında nasıl göründüğüne bakın.

Belirli Bir Gönderi Hakkında Veri Edinme

Yukarıdaki talebin ReqBin aracında nasıl göründüğüne bakın.

Gönderi Oluşturma

Yukarıdaki talebin ReqBin aracında nasıl göründüğüne bakın.

Gördüğünüz gibi, yük EasyCargo hesabınıza başarıyla kaydedildi.

API yöntemi tarafından oluşturulan yüklemeyi uygulamanızda kolayca açabilirsiniz.

Gönderinin Silinmesi

Yukarıdaki talebin ReqBin aracında nasıl göründüğüne bakın.

Gönderi, uygun taleple EasyCargo hesabınızdan doğru bir şekilde kaldırıldı.

API Hakkında Birkaç Bilgi Daha

• API isteklerinizin sayısı zamanla sınırlıdır (1 saatte 60 istek). Kotalar zaman dilimine göre kontrol edilir, bu nedenle herhangi bir zaman diliminde yalnızca belirtilen sayıda isteğe izin verilir.
• API hataları yaygın HTTP durum kodları ile geri gönderilir. Çoğu durumda, yanıt gövdesi neyin yanlış gittiğine dair belirli bir mesaj içerir.
• Yük planlama hesaplaması API üzerinden yürütülemez.
• API istemciniz, istek ve yanıt başlığına erişmeyi ve bunları değiştirmeyi ve JSON veya XML veri formatını ayrıştırmayı desteklemelidir.
• Yük planının hesaplanmasının işlenebilmesi için API kullanıcısının EasyCargo uygulamasında oturum açması gerekir.
• Bazı API yöntemleri, from gibi isteğe bağlı parametrelerin kullanımını destekler. Bunların her birinin anlamını doğal olarak belgelerden öğreneceksiniz. Bu parametreleri, örneğin, tüm yüklerin bir listesini almak için istekte bulunurken kullanabilirsiniz. Bunları kaynak adresine “?” karakterinden sonra “&” karakteri ile ayırarak name=value şeklinde eklemeniz yeterlidir, örneğin http://go.easycargo3d.com/api/v1/shipments?from=2020-01-02&offset=0&limit=100.

Bu makalenin sonucuna gelecek olursak, API çok kullanışlı bir hizmettir. Umarız bu pratik açıklama size bir programlama arayüzünün nasıl çalıştığı hakkında daha fazla bilgi vermiştir. Bugünkü makale, EasyCargo API’si hakkındaki serinin ikincisidir, bu nedenle ilk bölümü henüz görmediyseniz, burada bulabilirsiniz. Programlama arayüzü bir dizi olasılığın kapısını açıyor. Bir sonraki yazıda, API’mizi kullanarak ne gibi avantajlar elde edebileceğinizi öğrenecek ve gerçek hayattaki kullanım durumları hakkında bilgi edineceksiniz.