Rehber

Güvenilir API entegrasyonu için tasarım kontrol listesi

Veri sözleşmesi, tekrar deneme, idempotency, mutabakat ve izleme için güvenilir API entegrasyonu tasarım kontrol listesi; test senaryolarıyla birlikte.

Kısa yanıt

Güvenilir bir API entegrasyonu hatayı istisna değil normal durum sayar: zaman aşımı, hız limiti ve tekrarlanan mesaj baştan tasarlanır. Her kaydın ana kaynağı belli olmalı, işlem tekrarlandığında yinelenen kayıt oluşmamalı ve kaçırılan kayıtlar mutabakatla bulunabilmelidir.

Sözleşme ve kaynak sahipliği

Hangi alanın hangi sistemde yönetildiğini yazın. Veri türü, saat dilimi, para birimi ve benzersiz kimlikler açık olsun. API sürümü ve erişim kapsamı sağlayıcının resmi belgeleriyle doğrulansın.

Başarısızlığı normal durum olarak ele alın

Zaman aşımı, hız limiti ve geçici kesinti beklenen koşullardır. Hangi hatanın tekrar denenebileceği, bekleme politikası ve manuel inceleme kuyruğu belirlenmelidir. Doğrulama hatasını sınırsız tekrar etmek çözüm değildir.

Tutarlılık ve mutabakat

Olayın iki kez gelmesi veya sırasının değişmesi test edilmelidir. Kaynak ile hedef arasında periyodik mutabakat, kaçırılmış kayıtları bulabilir. İstek kimliği işlemin iki tarafta izlenmesini kolaylaştırır.

İşletim hazırlığı

İzleme, uyarı, kimlik bilgisi yenileme ve bağlantı kesildiğinde kullanıcıya gösterilecek durum tasarlanmalıdır. Entegrasyonun başarılı olması yalnızca ilk isteğin çalışmasıyla ölçülmez; hata sonrası toparlanma da kabul ölçütüdür.

Tekrar deneme ve tekrarlanan işlemler

Bir isteği tekrar denemek, aynı işlemin iki kez uygulanma riskini doğurur. Bunu önlemek için işleme benzersiz bir anahtar, örneğin sipariş kimliği, verilir ve hedef sistem aynı anahtarı ikinci kez gördüğünde yeni kayıt açmaz. Geçici hatalarda artan bekleme süresiyle sınırlı sayıda tekrar, kalıcı hatalarda ise bir inceleme kuyruğu kullanılır.

Uygulamaya geçmek için bir çalışma

Bir siparişin hedef sisteme gönderilmesini test edin. Aynı mesajı iki kez iletin, yanıtı geciktirin ve hedef sistemi geçici olarak kapatın. Tek kayıt oluştuğunu, yeniden denemenin sınırlı olduğunu ve başarısız işin inceleme kuyruğuna düştüğünü doğrulayın. Bu senaryoları gerçek müşteri verisi yerine test verisiyle çalıştırın.

Sık sorulan sorular

Bu konuda sık sorulan iki soru.

Webhook mu, periyodik sorgulama mı daha güvenilir?

Webhook anlık bildirim sağlar ancak kaçırılabilir; periyodik sorgulama daha yavaştır ama kaçırılan kayıtları yakalayabilir. Güvenilir entegrasyonlar çoğu zaman ikisini birleştirir: olayla hızlı tetikleme, periyodik mutabakatla telafi.

Entegrasyonu nasıl test etmeliyim?

Normal akışın yanında aynı mesajı iki kez gönderin, yanıtı geciktirin ve hedef sistemi geçici olarak kapatın. Tek kayıt oluştuğunu, yeniden denemenin sınırlı kaldığını ve başarısız işin görünür bir kuyruğa düştüğünü doğrulayın.

Kaynaklar ve ileri okuma

İlgili hizmet

Yazılım ve Teknik Danışmanlık ↗

Mimari, performans, teknik borç ve teknoloji seçimi kararları için kanıta dayalı, bağımsız teknik değerlendirme; bulgular, öncelikler ve yol haritası.

Bir sonraki adım

Projenizi değerlendirelim

Hedefinizi, mevcut araçlarınızı ve çözmek istediğiniz ihtiyacı kısaca paylaşın. Projeniz için uygun başlangıç noktasını birlikte belirleyelim.