İçeriğe geç

Idempotency

Idempotency-Key başlığıyla güvenli yeniden deneme.

Geliştirici belgesi

Ağ koptuğunda bir POST isteğinin sunucuya ulaşıp ulaşmadığını bilemezsiniz. Idempotency-Key başlığı aynı isteği güvenle yinelemenizi sağlar: aynı anahtarla gelen ikinci istek ikinci bir kayıt açmaz.

Kurallar

  • Her POST isteği Idempotency-Key başlığı ister; yoksa 400 idempotency_key_required döner. Değer 1 ile 255 karakter arasıdır; UUID önerilir.
  • Aynı anahtar ve aynı gövdeyle yinelenen istek, ilk isteğin durum koduyla kaynağın güncel hâlini ve Idempotent-Replayed: true başlığını döner. İlk yanıtın gövdesi saklanmaz (kişisel veri ikinci kez tutulmaz), yalnız oluşan kaydın kimliği saklanır; bu yüzden aradaki bir güncelleme yinelenen yanıtta görünür.
  • Aynı anahtar farklı bir gövdeyle gelirse 422 idempotency_key_reused döner.
  • İlk istek hâlâ sürüyorsa ikinci istek 409 idempotency_in_progress alır; biraz bekleyip aynı anahtarla yineleyin.
  • Pencere 24 saattir; daha eski bir anahtar yeni istek sayılır.
  • Anahtar API anahtarınıza bağlıdır: başka bir API anahtarının aynı değeri başka bir istektir. Döndürülen API anahtarı aynı aileden sayılır ve yarıda kalan yinelemeyi görür.
  • Doğrulama hatası (400) kayıt bırakmaz: isteği düzeltip aynı anahtarla gönderebilirsiniz.

PATCH

PATCH istekleri Idempotency-Key almaz. Gönderilen değerler mutlaktır: aynı isteği yinelemek kaydı aynı hâlde bırakır, ikinci bir olay ya da geçmiş satırı yazmaz. PATCH ön koşulsuzdur: eşzamanlı iki güncellemede son gelen geçerli olur.

Örnek

Hızlı başlangıç adım 6 ve 7, aynı isteği aynı anahtarla iki kez gönderir ve aynı kimliği alır.