API - Geliştirme Platformu

 

Turkishexportal ile güçlü bir uygulama oluşturun.

Turkishexportal Uygulama Programlama Arayüzü (API), site üyelerine, istedikleri platformdan verilerine ulaşıp üzerinde işlem yapabilme imkanını verir. API fonksiyonları, herhangi bir uygulama veya internet sitesi ile Turkishexportal arasında kolayca uygulanabilecek bir altyapı sunar. Üyelerin site üzerinde gerçekleştirdiği firma güncelleme, ürün ekleme / değiştirme / silme, haber ve referans ekleme / değiştirme / silme, mesajları okuma / yanıtlama / silme, ziyaretçi raporları gibi işlemlerin çoğu API aracılığıyla da kullanıcıların hizmetine sunulmaktadır. API REST biçiminde talepleri kabul edip birden çok yanıt türü (XML, JSON) dönebilmektedir.

API kullanımıyla ilgili bazı bilgiler ;

  • Her istek doğru ve geçerli bir API Erişim kodu bulundurmalıdır.
  • Tüm metodlar tek bir url altından farklı parametrelerle gönderilebilmektedir, https://wwww.turkishexportal.com/api/1.0/ (1.0 versiyon bilgisi olup zaman içinde değişim gösterecektir.)
  • Okuma istekleri GET, yazma istekleri (ekleme, değiştirme, silme) ise POST metodunu kullanmalıdır.
  • Tüm istekler mutlaka method parametresini bulundurmalıdır. Örnek bir istek , aşağıda gösterildiği gibidir :

    https://www.turkishexportal.com/api/1.0/company/update

API ile ilgili her türlü sorunuz için bizimle info@turkishexportal.com e-posta adresi ile iletişime geçebilirsiniz.

Temel Kavramlar

Temel Kavramlar sayfası API kullanımına dair gereksinimleri, genel bilgileri, hata kodlarını içermesi açısından önemlidir. API kullanımına bu bölümle başlamanızı tavsiye ederiz. Bir sonraki aşamada ise, API üzerinde kullanabileceğiniz metotları buradan görebilirsiniz. Son olarak, uygulamanıza API entegrasyonu yapmak için bir erişim kodu almalısınız.

İ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 metotlar 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.
  • language parametresi ile çalışacağınız dili ayarlayabilirsiniz.

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.

Sayfalama

count, page ve current parametreleri listeleme tarzı isteklerde gönderilecek verinin işlenebilir boyutta olmasını sağlar. 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 hata dönülecektir.

Yanıt Tipleri

Turkishexportal API 2 farklı biçimde yanıt gönderebilir ;

  • XML: Birçok programlama dili ve platformu tarafından kolaylıkla adapte edilebilir.
  • JSON: Gerek Javascript içinden eval fonksiyonu ile gerekse birçok programlama dili tarafından kabul görmüş başka bir yanıt tipidir.

Yanıt Tipi Nasıl Belirlenir ?

Alınmak istenen yanıt tipi gönderilen istek içindeki format parametresi ile sağlanır. Bu parameterenin gönderilmediği durumlarda standart olarak JSON tipinde yanıt dönülür. Değiştirilmek istenirse format=xml yada format=json parametresi eklenerek her isteğin yanıt tipi belirlenebilir.

XML

XML yanıtları Turkishexportal tarafından belirlenmiş özel bir XML biçimindedir.

https://www.turkishexportal.com/api/1.0/company/select?key=123&type=xml

Örnek istek - Kesilmiş

<?xml version="1.0"?>
<Company xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <accountype>F</accountype>
  <active>Y</active>
  <alias>test</alias>
  <businesstype>01</businesstype>
  <communication>
    <address1>Ahmet Sokak. Aykon Apt.</address1>
	.
	.
	.
</Company>

JSON

JSON (JavaScript Object Notation, json.org) basit ve kullanışlı veri bildirim biçimidir. Özellikle tarayıcı içinden kullanılacak Ajax uygulamalarında yoğun biçimde kullanılır.

https://www.turkishexportal.com/api/1.0/company/select?key=123&type=json

Örnek istek - Kesilmiş

{
    "accountype":"F",
    "active":"Y",
    "alias":"test",
    "businesstype":"01",
    "communication":{  
        "address1":"Ahmet Sokak. Aykon Apt.",    
    .
    .
    }
}

Parametreler

Portal içinde tanımlamalarda zaman zaman bu sayfadaki parametereler de kullanılmaktadır.

İsim Kod Açıklama
TL 04 İhracat ve Satış Müdürü Yardımcısı
05 İhracat Müdürü Yardımcısı
06 Genel Müdür Yardımcısı
10 Satış Müdürü Yardımcısı
100 Mühendis
101 Genel Müdür
103 Uluslararası Pazarlama Yardımcısı
104 Uluslararası Pazarlama Müdürü
109 Uluslararası Satış Müdürü
116 Müdür
118 Yönetici Direktör
123 Pazarlama ve Satış Temsilcisi
128 Pazarlama Müdürü
129 Pazarlama Temsilcisi
13 İş Geliştirme Müdürü
139 Firma Sahibi
14 İş Geliştirme Uzmanı
143 Ortak
160 Temsilci
161 Satış ve İhracat Direktörü
162 Satış ve İhracat Müdürü
164 Satış ve Pazarlama Müdürü
17 CEO
170 Satış Müdürü
171 Satış Temsilcisi
35 Direktör
36 İş Geliştirme Direktörü
37 İthalat İhracat Direktörü
38 Satış ve Lojistik Direktörü
46 İhracat ve İthalat Yardımcısı
48 İhracat ve İthalat Müdürü
49 İhracat ve İthalat Temsilcisi
62 İhracat Direktörü
65 İhracat Müdürü
69 İhracat Temsilcisi
72 İhracat Satış Temsilcisi
82 Yurt Dışı Satış Müdürü
83 Yurt Dışı Satış Temsilcisi
92 Dış Ticaret Müdürü
95 Dış Ticaret Temsilcisi
98 Kurucu / Müdür
99 Ar-Ge Mühendisi
İsim Kod Açıklama
ER 01 1 - 10
02 10 - 50
03 50 - 100
04 100 - 250
05 > 250

Erişim Kodu

Turkishexport API aracılığıyla yapılan tüm isteklerde apikey alanında doğru ve geçerli bir erişim kodu gönderilmelidir. Erişim kodunuzu lütfen güvenli bir ortamda saklayınız. Üyeliğiniz dahilinde verilen koda sahip olunması durumunda veri güvenliğinizin tehlikeye gireceğini unutmayınız. Bu tür durumlarda info@turkishexportal.com e-posta adresi üzerinden iletişime geçerek kodunuzun iptal edilmesini mutlaka sağlayınız. API Erişim Kodu içeren örnek bir istek aşağıda gösterilmiştir.

https://www.turkishexportal.com/api/1.0/company/select?format=xml&apikey=f893a3bf3cfc432a8e304f07e5ea11f5

Yukarıdaki örnekte kullanılan apikey geçerli bir erişim kodu değildir. Sadece örnek olması açısından verilmiştir. Lütfen kendi uygulamanızda size özel tahsis edilen apikey API Erişim Kodunu kullanınız.

Metot Listesi

Company

Update
Alan Açıklama Tip
name Şirket Adı Varchar [100]
<?xml version="1.0"?>
<Company xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <uid>33d27f2c6ed0403f98ab0219e3fec20e</uid>
  <name>Test Co Ltd.</name>
  <history>Test is the company that provides the best product.</history>
  <email>info@test.com</email>
  <mf>M</mf>
  <representative>Test Person</representative>
  <establishdate>1965</establishdate>
  <businesstype>01</businesstype>
  <statistic>
    <itemscount>4</itemscount>
    <newscount>1</newscount>
    <referencecount>1</referencecount>
    <certificatecount>2</certificatecount>
  </statistic>
</Company>

Hata Listesi

Kod Açıklama
100 Kayıt Bulunamadı
110 Lütfen geçersiz alanları kontrol ediniz.
255 Hata oluştu.

Kod Çalıştırma

 

En Üste Git