Dokümantasyon

Vakıfbank API Store ile API’larımıza erişebilir, API’larımızı test edebilir ve kendi uygulamalarınızda kullanabilirsiniz.


Hesap Oluşturma

Portale giriş yapabilmeniz için öncelikle Signup aracığıyla hesap oluşturmanız gerekmektedir. Hesabınızın aktifleşmesi durumunda Login aracılığıyla giriş yapabilirsiniz.


Uygulama Oluşturma

Giriş yaptığınız hesabınız ile API’larımızı kullanabilmek için kendi uygulamanızı yaratmalısınız. Uygulamanıza birden fazla API ekleyebilirsiniz.

Application Information sekmesi ile uygulama adınızı girip, platform tipinizi seçmelisiniz. İstendiği takdirde uygulamanız hakkında bir açıklama girebilirsiniz.


API Management sekmesinde uygulamanızda kullanmak istediğiniz API’larımızı kullanım koşullarımızı kabul ederek ekleyebilir ardından Auth sekmesi ile API'larımız üzerinden yetkilendirme yapabilirsiniz.


Uygulamanızı kaydetmeniz durumunda uygulamanız Application tabı altında listelenecektir. API Usage butonu ile uygulamanıza ait API’ları ve kota durum bilgilerini görebilirsiniz.


Eklediğiniz uygulamanız ilk olarak Pending Approval statüsünde gözükecektir. Sistem tarafından onaylanması durumunda statüsü Active olarak güncellenecek ve uygulamanıza otomatik API Key atanacaktır. Ayarlar sembolü ile uygulamanıza API ekleyip çıkarabilir, disable edebilir veya uygulamanızı silebilirsiniz.



API Listesi ve Planlarına Erişme

APIs & Plans sekmesi APIs tabı ile public olan API listesine, Plans tabı ile API’lere ait kota bilgilerine, kullanabilme ve çağrılma sürelerine erişebilirsiniz.


API Servis Detay Bilgilerine Erişme

Tüm API’lara ait web servis girdi ve çıktı bilgilerine, örnek istek ve cevaplara Documentation sekmesinden erişebilirsiniz. Uygulamanıza eklediğiniz API’ları bu sekme üzerinden de test edebilirsiniz.


API’ları Test Etme

Portalde Resourse sekmesi API Explorer tabı ile seçtiğiniz API ve uygulamanız üzerinden kimlik doğrulama servisi seçilerek requestlerinizi gönderirseniz API’nın döneceği response bilgisini görebilirsiniz.



API Kullanımı

Sistem tarafından uygulamanız özelinde üretilen API Key ve API Secret ile authentication olduktan sonra API’ları, APIs & Plans sekmesinde belirtilen bilgiler doğrultusunda çağırabilirsiniz.


Gerçek Ortama Geçiş

VakıfBank API test sürecinizin tamamlanmasından sonra gerçek ortama geçmek için API'larınızın mevcut API Planlarını Production olarak değiştirme talebinde bulunmalısınız. API Plan değişikliği sistem tarafından onaylanması durumunda API'lar gerçek ortamda kullanılabilir duruma gelmiş olacaktır.



Destek

Her türlü API kullanım sorularınız için  apiportaldestek@vakifbank.com.tr e-mail adresine dönüş yapabilirsiniz.