Temel Kavramlar

İstekler

• Yanıt Tipleri ile API isteklerine belirlediğiniz biçimde yanıt alabilirsiniz.
• Tüm okuma [GET] ve yazma talepleri [POST] geçerli bir erişim kodu bulundurmalıdır.
• İstek içinde yer alan method parametresi metodlar listesinde yer alanlardan biri olmalıdır.
• Güncelleme işlemlerinde [.update] sadece gönderilen geçerli parametrelere ait bilgiler güncellenecektir, diğer bilgiler korunacaktır.
• Ondalıklı gönderilmesi gereken tüm nümerik parametrelerde nokta [.] ondalık ayıracı olarak kullanılacaktır. Örnek: 1345.72
• Tarih bilgisi gönderilmesi gereken parametrelerde biçim dd/mm/yyyy şeklinde olmalıdır. Örnek: 17/09/2005
• Mantıksal veriler boolean kelimesi ile belirtilmekte olup, bu alanlarda 1 veya 0 değerleri atanmalıdır.

Yanıtlar

• Yanıtlar UTF-8 biçiminde kodlanmaktadır.
• Tüm yanıtlarda timestamp bilgisi [ yyyyMMddHHmmss ] gönderilmektedir. Örneğin : 20091211153544
• Hata kodları ve açıklamaları için Hatalar bölümünü inceleyiniz.
• Channel alanı ile gönderilen kanal bilgisine ait açıklama aşağıda gösterildiği gibidir :
  • W Web
  • M Mobil
  • I iPhone
  • A API
  • F Facebook
  • T Twitter
  • P Pinterest

Sayfalama

count, page ve current parametreleri listeleme tarzı isteklerde gönderilecek verinin işlenebilir boyutta olmasını sağlar. Aksi taktirde büyük boyuttaki veriler hem portalın hem de isteği gönderenin işlem yapamaz hale gelmesine sebep olur.

Listelemelerde dikkat edilmesi gereken hususlar ;

• Verilen yanıtlarda sayfa başına kayıt gösterim adeti firma üyeliğinize tanımlı adet ile aynıdır.
• Yanıt içindeki kayıt sayısı count, sayfa sayısı page, aktif sayfa numarası ise current alanlarında gönderilmektedir.
• Gönderilen taleplerde page değeri gönderilmediği sürece ilk sayfaya ait veri dönülecektir.
• page parametresi 1 ile page arasında bir değer olmalıdır. Bu aralıkta olmayan sayfa taleplerine 1011 hata kodu dönülecektir.

Çoklu Dil Desteği

Turkishexportal API, Türkçe [tr] ve İngilizce [en] olmak üzere iki dilde yanıt dönebilmektedir. Hesap üstündeki dil tanımına göre verilen yanıt değişiklik göstermektedir.

İlerleyen süreçte desteklenen dil sayısı arttırılacaktır.