İş gereksinimleri
Ürünler, pazarlar, kullanıcı rolleri, finansal kurallar, kısıtlamalar ve beklenen sonuç.
Dokümantasyon / API Gereksinimleri
API bağlamadan önce neler hazırlanmalı
Entegrasyon başlamadan önce proje, erişim, veri, güvenlik ve test senaryosu bilgilerini hazırlayın. Bu, kapsamı önceden tanımlamaya ve yeniden çalışmayı önlemeye yardımcı olur.
Kapsam
ürünler ve pazarlar
Erişim
anahtarlar ve ortamlar
Veriler
formatlar ve durumlar
Kabul
senaryo testleri
Gereksinim paketi
Çalışma başlamadan önce neler kararlaştırılmalı
01
Proje gereksinimleri
Ürünler, pazarlar, para birimleri, sağlayıcılar, kullanıcılar ve operasyonel süreçler.
02
Veri alışverişi kuralları
İstekler, alanlar, kimlikler, durumlar, hatalar ve olaylar.
03
Erişim ve güvenlik
Erişim anahtarları, istek imzaları, izin verilen IP adresleri, roller ve faaliyet günlükleri.
04
Test ve kabul
Test verileri, başarılı ve hatalı senaryolar, sonuç doğrulama ve lansman kriterleri.
Genel bakış
Kararlaştırılmış gereksinimler teslim süresini ve yeniden çalışmayı azaltır
Çalışma başlamadan önce her iki taraf da proje hedefleri, veri kaynakları, işlem durumları, sistem sorumlulukları, güvenlik kuralları ve kabul kriterleri konusunda aynı anlayışa sahip olmalıdır. Böylece entegrasyon varsayımlara değil, kararlaştırılmış tasarıma göre ilerler.
Entegrasyon kuralları
Veri alışverişi yöntemleri, istek ve yanıt yapıları, kimlikler, durumlar, bildirimler, hatalar ve limitler.
Kabul kriterleri
Test senaryoları, beklenen veriler, raporlar, operasyonel izleme ve lansmana geçiş kriterleri.
Proje verileri
Proje ve bağlı sistem bilgileri
Önce genel bağlamı belirleyin: hangi ürünlerin bağlandığı, hangi sistemlerin yer aldığı, ana verinin nerede saklandığı ve her sürecin sahibinin kim olduğu.
Proje kapsamı ve hedefleri
Ürünler: casino, spor bahisleri, ödemeler, KYC, CRM, bonuslar, raporlama veya back office.
Ülkeler, lisanslar, para birimleri, diller, markalar ve kullanım kanalları.
Kullanıcı türleri, roller, limitler, durumlar ve temel operasyon senaryoları.
Öncelikler, lansman aşamaları, kritik işlevler ve ticari kısıtlamalar.
Sistemler ve veri sahipliği
Süreçte yer alan dahili ve harici sistemlerin listesi.
Oyuncu, bakiye, işlem, bahis, bonus veya KYC kontrolü verileri için ana kayıt sistemi.
Mevcut API'ler, veritabanları, mesaj kuyrukları, bildirimler, dosyalar ve legacy arayüzler.
Sorumlu ekipler, operasyonel iletişim kişileri ve karmaşık sorunlar için escalation prosedürleri.
Entegrasyon gereksinimleri
API veri alışverişi gereksinimleri
Dokümantasyon, entegrasyonun tahmine gerek kalmadan tamamlanmasını sağlamalıdır. Her işlem için amacı, girdi verilerini, sonucu, olası hataları ve tekrar kurallarını önceden tanımlayın.
Endpoint'ler ve istek yöntemleri
Temel API URL'si, istek yolları, HTTP yöntemleri, parametreler, header'lar ve her işlemin amacı.
İstek ve yanıt formatları
Veri türleri, zorunlu alanlar, tarih formatları, tutar hassasiyeti, izin verilen null değerleri ve örnekler.
İşlem durumları
Oluşturmadan tamamlanmaya kadar tam işlem yaşam döngüsü, izin verilen geçişler ve nihai durumlar.
Hatalar ve eylemler
Hata kodları, açık nedenler, tekrar denemeye izin verilip verilmediği ve alıcı sistemin yapması gereken eylem.
Olay bildirimleri
Olay yapısı, imzalama, teslimat, alındı onayı, yeniden teslimat ve işleme sırası.
Yinelenen işlemlere karşı koruma
Benzersiz işlem kimliği, yinelenen isteklerin tanınması ve hata sonrası güvenli kurtarma.
Limitler ve yük
İstek sıklığı, zaman aşımı, eşzamanlı işlemler, yanıt boyutu ve beklenen tepe yük.
Sürüm değişiklikleri
API sürümü, geriye dönük uyumluluk, bildirim süresi ve değişiklik yönetimi prosedürü.
Güvenlik ve erişim
Güvenlik ve erişim yönetimi gereksinimleri
Canlı veriler aktarılmadan önce kimlik doğrulama yöntemlerini, istek imzalamayı, ağ kısıtlamalarını, kullanıcı yetkilerini, anahtar saklamayı ve faaliyet günlüklemeyi kararlaştırın.
API erişimi
API anahtarları, OAuth, JWT, servis hesapları, token süreleri ve planlı rotasyon.
İstek imzalama
HMAC doğrulaması, istek zamanı ve replay'e karşı koruma için benzersiz değer.
Ağ erişimi
İzin verilen IP adresleri ve alan adları, güvenli bağlantılar, VPN, ağ kuralları ve test/canlı ortam ayrımı.
Roller ve yetkiler
Servis ve personel yetkileri en az ayrıcalık ilkesiyle atanır.
Veri koruma
Şifreleme, hassas değerlerin maskelenmesi, saklama süreleri, silme ve kişisel verilerin işlenmesine ilişkin kurallar.
Faaliyet günlüğü
İstek kimliği, aktör, zaman, değişiklikler, hatalar ve kritik işlemlerin geçmişi.
Test ve kabul
Test ve kabul gereksinimleri
Test ortamı yalnızca başarılı işlemleri değil; hataları, gecikmeleri, tekrarları, limitleri ve nihai raporlamayı da yeniden üretmelidir.
Test ortamı
Ayrı endpoint'ler, erişim anahtarları, bildirim alıcıları, kısıtlamalar ve veri sıfırlama kuralları.
Test verileri
Tekrarlanabilir senaryolar için oyuncular, para birimleri, ödeme yöntemleri, sağlayıcılar, durumlar ve değerler.
Başarılı senaryolar
İlk istekten nihai duruma ve bunun raporlamaya yansımasına kadar tam iş akışı.
Hata senaryoları
Geçersiz veri, zaman aşımı, yinelenen işlemler, yetersiz bakiye, redler ve sağlayıcı hataları.
Günlükler ve teşhis
İstek kimliği, kesin zaman, orijinal durum ve ortak inceleme için gereken veriler.
Kabul
Kararlaştırılmış senaryo listesi, beklenen sonuçlar ve onaydan sorumlu kişiler.
Hazır olma kontrol listesi
Geliştirme başlamadan önce minimum kontrol listesi
Kapsam, veri alışverişi kuralları, erişim, test ortamı ve sorumlu taraflar kararlaştırıldıktan sonra entegrasyon planlaması başlayabilir.
Entegrasyon kapsamı onaylandı
Ürünler, pazarlar, sistemler, işlevler ve lansman aşamaları dokümante edilmiştir.
API dokümantasyonu mevcut
Endpoint'ler, veri formatları, durumlar, hatalar, bildirimler ve örnekler dokümante edilmiştir.
Test erişimi verildi
Anahtarlar aktiftir; izin verilen IP adresleri ve bildirim endpoint'leri kararlaştırılmıştır.
Güvenlik kararlaştırıldı
Kimlik doğrulama yöntemleri, imzalama, roller, anahtar saklama ve günlükleme tanımlanmıştır.
Test senaryoları hazırlandı
Başarılı, hatalı, yinelenen ve arıza senaryoları mevcuttur.
Sorumlular atandı
Ürün, geliştirme, test, güvenlik ve destek sorumluları belirlenmiştir.
Gereksinimlerin hazır olup olmadığını gözden geçirmeniz mi gerekiyor?
Dokümantasyonu, sistem listesini, süreç açıklamalarını ve mevcut ortamları bize iletin. APIACE geliştirme başlamadan önce eksik bilgileri belirlemeye yardımcı olacaktır.