GoFeed2 Dinamik API

Transkript

GoFeed2 Dinamik API
GoFeed2 Dinamik API
GoFeed2 Dinamik API; Gofeed panele ihtiyaç duymadan, çeşitli parametreleri kullanarak XML veya
JSON formatında hızlıca Ürün, Fırsat ve Özel Alışveriş ürünlerine erişmeyi sağlayan bir GelirOrtakları
hizmetidir. Dinamik API sorgulamalar yaparak ürün listelemeyi sağlayan bir veri paylaşım modelidir.





Kullanılabilir Dinamik API Metodları nelerdir?
Sayfalatma nasıl yapılır?
Listeleme formatları nedir? nasıl değiştirilir?
Hata mesajları!
XML Yapısı nasıl?
Metodlar
GoFeed2 Dinamik API modelinde 5 adet metod bulunmaktadır. Metodlar altında ihtiyaç duyulan
zorunlu ve opsiyonel parametre listesine ve kullanım şekillerine ulaşabilirsiniz.
Metod
Açıklama
getcategories GoFeed bünyesinde bulunan tüm ürünleri kapsayan kategori ağacına ve kategori ID lerine
erişilebilmesini sağlayan metoddur. Bu metod ile Dinamik API de belirlenen kategorilerde
sorgular yaparak çıktılarını elde edilebilmektedir.
getproviders
GoFeed bünyesine ürün sağlayan Sağlayıcı ve bu Sağlayıcılara ait ID lerini veren metoddur.
getcities
Dinamik API de sorgu yapabileceğiniz Şehir listesini vermektedir.
getgender
Dinamik API de tanımlı Cinsiyet ve bu Cinsiyetlere ait ID leri vermektedir.
dynamic
Dinamik API de diğer metodlardan alınan parametreler(Kategori,Sağlayıcı,Şehir,Cinsiyet,
İndirim/fiyat oranı ve ürün arama) kullanılarak ürün listeleme için kullanılan ana metoddur.
Diğer tüm metodlardan elde edilen değerler parametre olarak bu metodda kullanılabilmektedir.
getcategories metodu
Kategori isimlerini ve kategori ID lerini 3lü kategori ağacı yapısında listeleme için kullanılan metoddur.
Kaynak URL
http://api.gelirortaklari.com/getcategories
Parametreler
Parametre
Açıklama
keyzorunlu
API key size ait bir parola gibidir. Gofeed API yi
çalıştırmak istediğiniz tüm metodlarda zorunlu olarak
girilmesi gereken parametredir.
Örnek sorgu
http://api.gelirortaklari.com/getcategories?key=xxxxxxxxxxx
Sorgu cevabı
<categories>
<category id="1001" name="Aile">
<subcategories>
<category id="1017" parent_id="1001"
name="BebekBakım">
<subcategories>
<category id="1063" parent_id="1017"
name="BebekBakım"></category>
<category id="1069" parent_id="1017"
name="GüvenlikAletleri"></category>
</subcategories>
</category>
<category id="1018" parent_id="1001" name="HızlıTüketimMalları">
<subcategories>
<category id="1072" parent_id="1018"
name="Temizlik"></category>
<category id="1073" parent_id="1018"
name="Yiyecek_Gurme"></category>
</subcategories>
</category>
</categories>
getproviders metodu
Ürün sağlayıcıları listeleyen method.
Kaynak URL
http://api.gelirortaklari.com/getcategories
Parametreler
Parametre
Açıklama
keyzorunlu
API key size ait bir parola gibidir. Gofeed API yi
çalıştırmak istediğiniz tüm metodlarda zorunlu olarak
girilmesi gereken parametredir.
stateopsiyonel Bu parametre sayesinde Gelir Ortakları'nından
erişiminize izin verilen onaylı ve onaysız Sağlayıcılara
erişebilirsiniz. Eğer herhangi bir değer verilmez ise
öntanımlı olarak sadece Onaylı Sağlayıcıları
listelemektedir.
Alabileceği değerler : approved, unapproved, all
Örnek sorgu
http://api.gelirortaklari.com/getproviders?key=xxxxxxxxxxx&state=approved
Sorgu cevabı
<providers>
<provider
<provider
<provider
<provider
<provider
<provider
</providers>
id="141"
id="161"
id="163"
id="212"
id="244"
id="260"
name="Darty"/>
name="Teknosa"/>
name="Markapon"/>
name="Yakala.co"/>
name="Birlikte Alalim"/>
name="Hizli Al"/>
getcities metodu
Şehir listesinin alındığı metod.
Kaynak URL
http://api.gelirortaklari.com/getcities
Parametreler
Parametre
Açıklama
keyzorunlu
API key size ait bir parola gibidir. Gofeed API yi
çalıştırmak istediğiniz tüm metodlarda zorunlu olarak
girilmesi gereken parametredir.
Örnek sorgu
http://api.gelirortaklari.com/getcities?key=xxxxxxxxxxx
Sorgu cevabı
<cities>
<city>Adana</city>
<city>Adıyaman</city>
<city>Aksaray</city>
<city>Amasya</city>
<city>Ankara</city>
<city>İstanbul</city>
<city>Bursa</city>
</cities>
getgender metodu
Cinsiyetleri ve ID lerini listelenebileceği metoddur.
Kaynak URL
http://api.gelirortaklari.com/getgender
Parametreler
Parametre
Açıklama
keyzorunlu
API key size ait bir parola gibidir. Gofeed API yi
çalıştırmak istediğiniz tüm metodlarda zorunlu
olarak girilmesi gereken parametredir.
gender_idopsiyonel Cinsiyet ID sini öğrenmek için kullanılır.
Alabileceği değerler : 1 (Erkek için) , 2 (Kadın
için)
Örnek sorgu
http://api.gelirortaklari.com/getgender?key=xxxxxxxxxxx
Sorgu cevabı
<genders>
<gender id="1">Erkek</gender>
<gender id="2">Kadın</gender>
</genders>
dynamic metodu
Dinamik API nin en işlevsel metodu. Çeşitli parametrelerle güncel ürünleri listelemeye olanak
sağlamaktadır.
Kaynak URL
http://api.gelirortaklari.com/dynamic
Parametreler
Parametre
Açıklama
keyzorunlu
API key size ait bir parola gibidir. Gofeed API yi
çalıştırmak istediğiniz tüm metodlarda zorunlu
olarak girilmesi gereken parametredir.
categoryopsiyonel Kategorilerdeki ürünleri listeleme için
kullanılmakta, çoklu seçim yapabilirsiniz.
Alabileceği değerler : Sayısal değer
getcategories metodundan alınan tüm
subcategories kullanılabilir. Ör : 1071,1073
provideropsiyonel Satıcı seçimi yaparak ürünleri listeleme için
kullanılmakta, çoklu seçim yapabilirsiniz.
Alabileceği değerler : Sayısal değer
getprovider metodundan alınan tüm sağlayıcı id
leri kullanılabilir. Ör: 25, 44
cityopsiyonel
Şehirlere göre ürünleri listeleme için
kullanılmakta, çoklu seçim yapabilirsiniz.
Alabileceği değerler : Sadece şehir isimleri
getcities metodundan alınan tüm şehir isimleri
kullanılabilir.Ör: İstanbul, ankara (İstanbul ve
ankara ürünleri)
discountopsiyonel Ürünleri İndirim/Fiyat Oranı na göre listeleme
yapmak için kullanılmakta. Bu orandan büyük olan
ürünleri listeler.
Alabileceği değer : Sayısal değer.
Ör: 10 (%10 dan daha fazla indirimde olan
ürünler).
Parametre
Açıklama
queryopsiyonel
Ürün arama için kullanılır. +, - ve " parametreleri
kullanılabilir.
Ör: +kırmızı +ayakkabı => tüm kırmızı ve ayakkabı
kelimelerini içeren ürünleri listeler
+kırmızı -ayakkabı => İçinde kırmızı geçen fakat
ayakkabı kelimesi geçmeyen ürünleri listeler
"kırmızı ayakkabı" => İkili olarak arama yapar,
içinde "kırmızı ayakkabı" kelime gurubu geçen
ürünleri listeler
genderopsiyonel
Cinsiyet seçimi için kullanılır.
Alabileceği değerler : 1 (Erkek için) , 2 (Kadın için)
Örnek sorgu
http://api.gelirortaklari.com/dynamic?key=xxxxxxxxxxx&provider=45,48&category=1071&gen
der=1
Sorgu cevabı
<products>
<product>
<product_id>48759001</product_id>
<product_url>
http://tr.rdrtr.com/aff_c?offer_id=212&aff_id=
</product_url>
<title>
Renault Symbol (dizel) 65 TL yerine 34,90 TL!
</title>
<image>
http://static.yakala.co/Images/Products/Main/8677_6F.jpg.ashx?width
=450
</image>
<description1>
Gaziemir Perito Rent A Car’dan araç kiralama
</description1>
<provider_name>Yakala.co</provider_name>
<category1>ÇeşitliHizmetler</category1>
<category2>Hizmetler</category2>
<category3>Hizmetler</category3>
<price>60.00</price>
<deal_price>34.90</deal_price>
<discount>42</discount>
<city>İzmir</city>
<start_date>1353542400</start_date>
<end_date>1353628800</end_date>
</product>
</products>
Örnek sorgu
http://api.gelirortaklari.com/dynamic?key=xxxxxxxxxxx&provider=45&offset=0&count=20000
Sayfalatma
Dinamik API de listelenen ürünler çeşitli parametreler yardımıyla sayfalatılabilmektedir.
Parametreler
Parametre
Açıklama
page
Sayfa parametresidir. count verilmez ise öntanımlı
olarak 5000 ürün listeler.
count
Count ile verilen değer kadar ürün listeler.
offset
Offset ile verilen indeksten başlayarak ürünleri
listeler ve count ile beraber kullanılır.
*** Count değeri maksimum 20,000 ürün aralığı
olarak kullanılabilir.
Örnek sorgu
http://api.gelirortaklari.com/dynamic?key=xxxxxxxxxxx&provider=45,48
Sorgu cevabı
<xmlfeedinfo>
<result>success</result>
<itemcount>16102</itemcount>
</xmlfeedinfo>
Örnek sorgu
http://api.gelirortaklari.com/dynamic?key=xxxxxxxxxxx&provider=45,48&page=1
Sorgu cevabı
ilk 5000 ürün listelenir, page parametresi artırılarak diğer ürünlere 5000er adet şeklinde erişilir
Örnek sorgu
http://api.gelirortaklari.com/dynamic?key=xxxxxxxxxxx&provider=45,48&page=1&count=100
Sorgu cevabı
ilk 100 ürün listelenir, page parametresi artırılarak diğer ürünlere count da belirtilen 100er adet erişilir
Örnek sorgu
http://api.gelirortaklari.com/dynamic?key=xxxxxxxxxxx&provider=45,48&offset=100&count=2
50
Sorgu cevabı
100üncü üründen başlayarak 250 adet ürün listelenir.
Örnek sorgu
http://api.gelirortaklari.com/dynamic?key=xxxxxxxxxxx&provider=45&offset=0&count=20000
Sorgu cevabı
İlk 20000 ürün listelenir, offset parametresi 20000 yapılıp, diğer ürünlere count da belirtilen değer ile
ulaşılır.
Hata mesajları
Dinamik API de karşılaşılabilecek hata mesajları.
Mesajlar
Hatalı API key, lütfen bu mesajı gördüğünüzde API key'inizin doğruluğundan emin olunuz.
<xmlfeedinfo>
<result>failure</result>
<error>API key not found</error>
</xmlfeedinfo>
Listeleme formatları
Dinamik API de listeleme parametresi output ve İki çeşit listeleme formatı
bulunmaktadır: xml ve json. Kullanımı output=xml veya output=json şeklindedir.Herhangi bir
parametre verilmezse öntanımlı olarak XML üretilir.
http://api.gelirortaklari.com/dynamic?key=xxxxxxxxxxx&provider=45,48&page=2&output=json
json formatında çıktı vermektedir.
http://api.gelirortaklari.com/getcategories?key=xxxxxxxxxxx&output=xml xml formatında çıktı
vermektedir.
XML Yapısı
Dinamik API de üretilen XML yapısındaki etiketler ve karşılıkları
Etiket
Açıklama
product_id
Ürüne ait benzersiz ID numarası, sayısal bir değerdir.
product_url
Ürüne erişim için oluşturulan URL, otomatik olarak Yayıncı ID si ve ilgili
parametreler URL e eklenmiştir.
title
Ürün başlık metni
image
Ürün resim URL'i
description1
Ürün açıklaması
Etiket
Açıklama
description2
Ürün açıklaması
description3
Ürün açıklaması
provider_name
Ürün sağlayıcı adı. Ör:Teknosa, darty
model_name
Ürün Model adı Ör: Sony vaio
brand_name
Ürüne ait marka adı. Ör: Sony
merchant_category
Ürüne sağlayıcı tarafından verilmiş olan kategori.
category1
Gofeed tarafından kategorilendirilen ürünün en alt kategorisi.
category2
category1 in bir üst kategorisi
category3
category1 in bir üst kategorisi
Etiket
Açıklama
price
Ürün fiyatı
deal_price
Ürün indirimli fiyatı
discount
Ürün indirim oranı
city
Ürüne ait şehir bilgisi
gender
Cinsiyet bilgisi
start_date
Ürün başlangıç tarihi
end_date
Ürün bitiş tarihi

Benzer belgeler