Başarılı REST API entegrasyonu, iki sistemin teknik olarak cevap vermesinden önce hangi iş olayını ve hangi veri sahipliğini paylaşacağını netleştirir.
İş sözleşmesini yazın
Siparişi hangi sistem oluşturacak, müşteri kodunun asıl kaynağı hangisi, iptal hangi durumlarda kabul edilecek ve başarılı aktarım ne anlama gelecek? Bu sorular endpoint listesinden önce cevaplanmalıdır. Aynı kaydı iki tarafın da serbestçe değiştirmesi çatışma üretir.
Teknik sözleşmeyi doğrulayın
- Ortam ve temel adresler
- Kimlik doğrulama ve anahtar yenileme
- İstek/yanıt alanları ile veri tipleri
- Sayfalama, hız sınırı ve zaman aşımı
- Hata kodları ve tekrar deneme koşulları
- Sürüm ve geriye uyumluluk politikası
Belge ile gerçek test ortamı arasında fark varsa örnek isteklerle erken doğrulama yapılmalıdır.
Alan eşleme tablosu
Kaynak alan, hedef alan, dönüşüm, zorunluluk ve geçersiz değer davranışı tek tabloda tutulur. Tarih dilimi, para birimi, ondalık ayırıcı ve durum sözlüğü gibi ayrıntılar üretim hatalarının sık kaynağıdır.
Başarısızlığı tasarlayın
Zaman aşımında işlemin karşı tarafta oluşup oluşmadığı belirsiz olabilir. Aynı isteği güvenle yinelemek için benzersiz işlem anahtarı, durum sorgusu veya mutabakat yöntemi gerekir. Hata kaydı hassas bilgiyi sızdırmadan takip kimliği taşımalıdır.
Canlıya geçiş kanıtı
Başarılı, doğrulama hatalı, yetkisiz, zaman aşımına uğrayan ve mükerrer istek senaryolarını çalıştırın. API entegrasyon hizmetini inceleyebilir; servis dokümanınızı değerlendirmek için entegrasyon ihtiyacınızı paylaşabilirsiniz.
Sözleşme değişikliğine hazırlanın
Sağlayıcının alan eklemesi, durum değeri değiştirmesi veya eski sürümü kapatması entegrasyonu etkileyebilir. Yanıtları katı ama ileriye uyumlu biçimde doğrulayın; bilinmeyen alanları gereksiz yere hata saymayın, bilinmeyen kritik durumları ise sessizce kabul etmeyin. Sürüm duyurularının sahibi ve test takvimi olsun. Örnek sözleşme testleri düzenli çalışırsa dış değişiklik canlı sipariş veya ödemeleri bozmadan önce görünür olur.