Dokümantasyon

 Ziraat Katılım Bankası  API Developer Portal, verilen API’ları kullanarak uygulamalar veya müşterileriniz için ürünler oluşturmanıza imkan verir.

 

Hesap Oluşturun

Ziraat Katılım Bankası API Developer Portal Geliştirici Hesabı İçin Kayıt Olun

 

Uygulamanızı Oluşturun:

Aktif bir hesabınız var ve API Developer Portal’a giriş yaptınız. Mesajlarınızı, uygulamalarınızı, API durumunu ve En Son API Dokümantasyonunu içeren "Dashboard" sayfanız  görüntülenmektedir.


Artık uygulamanızı oluşturmak için hazırsınız.

 

Erişeceğiniz API’ları barındıracak uygulamayı tanımlayın. Bir uygulama birden çok API içerebilir, ayrıca hesabınızda birden fazla uygulama oluşturabilirsiniz.

 

“Add Application” butonuna basarak uygulamanızı oluşturun. Uygulama formu bir diyalog içinde görüntülenmektedir.

 

“Application Information” sekmesinde uygulamanızın adını girin, “Platform” Türünü seçin -Android/Hybrid/iOS- ve uygulamanız için kısa bir açıklama girin. Bilgileri tamamladığınızda “API Management” sekmesine tıklayın.


 

“API Management” sekmesinde, uygulamanız için gerek duyduğunuz bir ya da daha fazla API’yı ekleyin.  API’ları seçtikten sonra “Auth” sekmesine tıklayın.

 
 

API’lar aşağıdaki doğrulama metotlarından biri kullanılarak API Doğrulama tarafından korunmaktadır:

·         API Anahtarı

·         OAuth 2.0

API Anahtarı kimlik doğrulaması bir API Anahtarı adı kullanır ve her API isteğinin istek sorgusu dizesine değer çifti eklenir.

“OAuth2.0 with Client Credentials” en güvenli doğrulama metodudur ve uygulamalar için gereklidir.

”Auth” sekmesinde, OAuth2.0 türü hizmet doğrulaması için “Type”tan “Confidential”ı seçin. Bilgileri tamamladığınızda, uygulamanızı kaydetmek için “Save” butonuna basın. 

 

Tam API Erişimi Edinin:

Artık uygulamanızı geliştirmeye başlamak için hazırsınız. API Developer Portal size API dokümantasyonu ve interaktif API test etme imkânları sunar.

API Dokümantasyonu

Her bir API için gerek duyulan bilgiler “Documentation” sayfasında verilmiştir ve API Developer Portal ana sayfasındaki “Documentation” menü ögesine tıklayarak erişilir.

 

API dokümantasyonu aşağıdakileri sağlar;

 

·         API’nın açıklaması

·         Uç nokta URL tanımları

·         İstek tanımı ve örnek istek mesajı

·         Yanıt tanımı ve örnek yanıt mesajı

·         Dönüş kodları ve Hata Düzeltme bilgileri ve Hata Mesajı

 

API’ları Test Etme

API Developer Portal, API’ları interaktif olarak keşfetmenize imkan tanır. API’nızı seçin, doğrulama hizmetini seçin, sorguları girin ve yanıtı görüntüleyin. Bu API’ları ve doğrulama metotlarını daha iyi anlamanızı sağlar.