Doğrulama

API’lar OAuth 2.0 Doğrulama tarafından korunmaktadır. OAuth 2.0 ile kullanılan Grant Type, Client Credentials’tır.

Client Credentials  onay türü için akış  şu şekildedir:

1. Ziraat  Katılım Bankası  API Developer Portal Manage Applications sayfası üzerinden OAuth 2.0 Client Credentials’ı edinin.

2. Client ID, Client Secret, Grant Type ve Redirect URL ile Ziraat Katılım Bankası API Developer Portal Token Endpoint’ten bir access token isteyin.

3. Access token, redirect_uri tarafından tanımlandığı şekilde belirtilen URL'ye yeniden yönlendirilir Uygulamanızın API’lara erişebilmesinden önce her bir istek için yeni bir access token edinmesi gerekir. Access token yalnız bir defa kullanılabilir.

 

 

Access Token Sorgu Parametreleri

Client ID

Ziraat Katılım Bankası API Developer Portal’dan kullanıcıya verilmiş olan kimliği girin. Bu Portal’da “Adding New Appplications” aracılığıyla oluşturulan API anahtarıyla aynıdır. 

Client Secret

Ziraat Katılım Bankası  API Developer Portal’dan kullanıcıya verilmiş olan istemci parolasını girin. Bu alan Key Secret ile aynıdır.

Scope

Uygun kapsam ve gerekliliklerin listesi için Ziraat Katılım Bankası API Developer Portal’a başvurun. Varsayılan olarak, Kapsam OOB ( Out of Band) olarak ayarlanacaktır

Grant Type

OAtuh 2.0 metodu dört temel onay türü tanımlamaktadır. Ziraat Katılım Bankası API Developer Portal, Client Credentials onay türünün kullanılmasını beklemektedir

Redirect URI

Access token bu URL’ye yeniden yönlendirilir. Bu alan, Portal’daki “Adding New Applications”ta bulunan Callback URL ile aynı olmalıdır.

 

Access Token Edinmek 


API’ları aramak için Access Token gereklidir. Client credentials grant type, Client ID, Client Secret and Redirect URL ile bir POST isteği yaparak token endpoint istemek için access token edinilir.

Access token almak için, geliştiricinin Ziraat Katılım Bankası API Developer Portal tarafından POST isteği ile eşzamansız olarak gönderilen access token’i alacak olan Rest Web Service oluşturması gerekir. Rest Web Service url, Uygulamaları oluştururken Ziraat Katılım Bankası  API Developer Portal’da belirlediğiniz callback url ile aynı olmalıdır.

 

Ziraat Katılım Bank API Developer Portal Token Endpoint :

https://apiportal.ziraatkatilim.com.tr/portal/auth/oauth/v2/token