Kararın dayanağı
Entegrasyon yalnızca iki API uç noktasını değil, iki sistemin işleyişini birbirine bağlar. Kayıtları, her alan için esas alınacak kaynağı, kimlik doğrulama yöntemini, zamanlama beklentisini ve kesintide sorumluluk alacak kişiyi belirleyin. Başarılı tek istek bunun küçük kısmını sınar.
Somut bir örnek
Varsayımsal kargo bağlantısında sipariş, adres düzeltme, sevk ve iptali izleyin. İç sipariş kimliğiyle taşıyıcı kimliğini bağlayın. Etiket oluşup yanıt kaybolursa ne olacağını belirleyin; kör retry ikinci gönderi oluşturabilir.
Değerlendirilecek seçenekler
Sonucun hemen gerektiği işlemlerde doğrudan çağrı uygun olabilir. Daha sonra tamamlanabilecek işler için kalıcı kuyruk, eksik kayıtları bulmak için düzenli mutabakat kullanılabilir. İşin hangi aşamada olduğunu açıkça göstererek bu yöntemleri birlikte kullanabilirsiniz.
Planın aksadığı yer
Sağlayıcı alanlarını uygulamaya yaymayıp eşleme sınırına alın, girdiyi doğrulayın. Geçici hatayla geçersiz adresi ayırın; yanlış veriyi tekrar göndermek toparlanma değildir.
Kayıt sözleşmesini iş diliyle yazın
Kargo örneğinde operatörün göreceği durumları açıklayın: gönderim bekliyor, taşıyıcı kabul etti, sevk edildi, iptal edildi, müdahale gerekiyor. Sistemleri bağlayan kimliği ve durum geçişi yapabilen olayları tanımlayın. Ağ yanıtı yalnızca isteğin ulaştığını gösterebilir; işin tamamlanması sonraki onaya bağlı olabilir. Her başarılı HTTP yanıtını tamamlanmış gönderiye çevirmeyin.
Eksik alanın, saat diliminin, ölçü biriminin ve isteğe bağlı değerin anlamını yazın. Boş teslimat notu “not yok” demekken güncellemede alanın hiç gelmemesi “mevcut değeri koru” olabilir. Gerçek sözleşmeyle sınayın. API sahibinden anahtar yenileme, istek limitleri, desteklenen sürümler ve test ortamını öğrenin. Henüz doğrulanmamış bilgileri kesin teslim tarihi hesabına katmayın; hangi bağımlılıkların hâlâ açıklığa kavuşturulması gerektiğini belirtin.
Kesilen aktarımın kurtarma sorumlusunu belirleyin
Taşıyıcı etiketi üretip yanıt gelmeden bağlantı kesilirse, desteklenen idempotency anahtarı veya sizin referansınızla sorgu işlemi güvenle çözebilir. İkisi de yoksa yeni gönderi açmak yerine kaydı incelemeye alın. Bu yolu gerçek müşteri siparişiyle değil yerel sahte servis veya izinli test ortamıyla gösterin.
Özel operatör komutu ya da ekranı başarısız referansı, güvenli hata kategorisini ve son doğrulanmış iş durumunu göstermeli. Retry aynı mantıksal kimliği koruyup ilk doğrulamadan geçmeli. Kimlik bilgileri, alan eşleştirme değişiklikleri ve günlük istisnaların sahiplerini belirleyin. Sürümlü örnek payload ve sözleşme testi sağlayıcı değişimini gösterebilir; değişen iş anlamını nasıl ele alacağına yine bir sorumlu karar vermeli.
İşe başlamadan önce
Hesap kime ait? Temsili test ortamı var mı? Operatör tek hatalı kaydı bulup güvenle yineleyebilir mi? Entegrasyon ortağıyla başarı ve hata kabulünü kararlaştırın.