API'de Hız Sınırı, Tek İstekte Davet ve Şablon Silme
API v1'de üç yenilik var: her API anahtarı için dakikada 60 istek tavanı (kurumsal entegrasyonlarda talep üzerine yükseltilebilir), belge yüklerken aynı istekte davet gönderebilme (send_invitations) ve şablonları API'den silebilme. Ayrıca istemci hatası olan birkaç durum artık 500 yerine doğru kodla dönüyor.
API v1 uçtan uca gözden geçirildi. Entegrasyonunuzu etkileyen değişiklikler aşağıda.
Anahtar bazında hız sınırı
Artık /api/v1 altındaki tüm uçlarda kural olarak API anahtarı başına dakikada 60 istek tavanı var. Daha önce yalnız birkaç uçta (toplu gönderim, zaman damgası, gömülü oturum) fren vardı; geri kalan uçlar sınırsızdı.
Sınır anahtar bazındadır, IP bazında değil: bir müşterinin entegrasyonu diğerinin bütçesini yemez. Uçlara özgü daha sıkı frenler yerinde kalır ve o uçlarda etkin sınır onlardır. Yoğun bir entegrasyonunuz varsa anahtarınıza özel bir tavan tanımlanabilir; destek üzerinden talep etmeniz yeterli.
Sınırı aşan istek 429 döner. İstemcinizin 429 gördüğünde bekleyip yeniden denemesi (üstel geri çekilme) önerilir.
Belge yüklerken tek istekte davet
Belge yükleme ucuna send_invitations parametresi eklendi. Daha önce belgeyi yükleyip ardından ayrı bir istekle daveti göndermek gerekiyordu; artık tek çağrıda ikisini de yapabilirsiniz. İki adım arasında kalan yarım kayıt riski ortadan kalkar.
Şablon silme
DELETE /api/v1/templates/:id eklendi. Silme yumuşak silmedir: şablon listelerden kalkar ve yeni sözleşmelerde kullanılamaz. Yanlışlıkla silinen bir şablon 30 gün içinde panelden geri alınabilir; süre dolduğunda kayıt günlük uyum işiyle kalıcı olarak imha edilir. Şablon aktif bir sözleşmede kullanılıyorsa 409 TEMPLATE_IN_USE döner ve silinmez.
Hata kodları netleşti
İstemci girdisinden kaynaklanan birkaç durum artık 500 yerine doğru kodla dönüyor:
| Durum | Önce | Şimdi |
|---|---|---|
| Geçersiz son imza tarihi | 500 | 400 INVALID_EXPIRY_DATE |
| Kimlik fotoğrafı olmadan yüz eşleştirme istenmesi | 500 | 400 MATCH_REQUIRES_ID_PHOTO |
| SMS hatırlatma üst sınırının aşılması | 500 | 429 MAX_SMS_REMINDERS_REACHED |
| Yüklenen dosyanın çok büyük olması | genel mesaj | 413 FILE_TOO_LARGE, mesajda gerçek sınır |
| Ölü davet bağlantısına hatırlatma | 500 | 409 |
Liste uçlarında limit değeri artık sessizce kırpılıyor, geçersiz page değeri 400 dönüyor. Aynı sözleşmeyi iki kez yaratmaya karşı tekrar koruması (idempotency) da bu turda sağlamlaştırıldı.
Tüm uçların güncel şeması api-docs.imzala.org adresinde.
Konuyla İlgili