66b0f09a8f10000000000001, örnek bağlantı kimliği
66b0f09a8f10000000000101 olarak kullanılacaktır.
Yetki ve güven sınırı
Bağlantı ve banka credential yönetimibank:connections, manuel
senkronizasyon bank:operate kapsamı ister. Her çağrıda x-api-key ile
x-api-secret birlikte; yazma çağrılarında ayrıca credential firmasıyla
eşleşen x-company-id gönderilir.
Banka credential değerleri kaydedildikten sonra hiçbir API cevabında geri
verilmez. Yalnız yapılandırma durumunu
GET /banks/accounts/{id}/credentials ile izleyebilirsiniz.
1. Bağlantıyı oluşturun
2. Banka alanlarını okuyun
Banka kataloğundaki alanlarıGET /banks/provider/variables/{bankCode} ile okuyun. Çoklu hesap destekleyen
hedef alanı aşağıdaki metadata ile döner:
Alan adı bankaya göre değişir:
Metadata’yı sabit bir istemci listesi yerine bu endpointten okuyun. Hedef alan
tek değerle gönderilse bile dizi olmalıdır.
3. Credential’ı ve iki IBAN’ı kaydedin
Değerleri yalnız backend ortamınızdan gönderin; loglamayın ve tarayıcı depolamasında tutmayın. Aktifbank örneği:4. Setup çalıştırın
POST /banks/accounts/{id}/setup bağlantıyı doğrular ve bankanın alt
hesaplarını keşfeder. Aktifbank, VakıfBank ve Türkiye Finans için Tahsil hedef
IBAN’ların her birini aynı ortak credential ile ayrı ayrı sorgular ve başarılı
sonuçları tek bağlantı cevabında birleştirir.
accounts içinde döndürür. Her alt hesap için kararlı
bir subAccountKey bulunur:
subAccountKey değerini saklayın; IBAN
maskelense veya sunum biçimi değişse bile bu anahtar alt hesap kimliğini korur.
5. İlk senkronizasyonu başlatın
Tarih vermediğinizde bağlantının olağan senkronizasyon kapsamı kullanılır. Kontrollü ilk alım içinYYYY-MM-DD biçiminde aralık gönderebilirsiniz:
subAccountKey alanı kaynak alt hesaba bağlanır. Aynı banka hareketi yeniden
gelirse providerStamp kimliği üzerinden tekrar oluşturulmaz. Farklı
hesaplardan aynı stamp gelirse veri sessizce birleştirilmez;
502 PROVIDER_STAMP_COLLISION döner.
Sync isteğini zaman aşımı sonrası güvenle yeniden gönderebilirsiniz; sonucu
bağlantı sağlığından doğrulayın.
6. Sağlığı izleyin
GET /banks/accounts/{id}/health; son setup ve sync denemesini, son başarılı
çalışmayı, hata kodunu, süreyi ve schedule durumunu tek cevapta verir.