سازگاری API

تعهد نسخه‌بندیکپی پیوند بخش

نسخهٔ API در مسیر URL آمده است. امروز فقط /v1 وجود دارد.

• تغییرهای v1 فقط افزایشی هستند. ما endpoint، فیلد اختیاری درخواست، فیلد پاسخ و نوع رویداد اضافه می‌کنیم. فیلدی را حذف یا تغییر نام نمی‌دهیم، معنای آن را عوض نمی‌کنیم و فیلد اختیاری را اجباری نمی‌کنیم. کلاینت شما باید فیلدهای ناشناختهٔ پاسخ را نادیده بگیرد.
• تغییر ناسازگار به‌صورت /v2 منتشر می‌شود. دست‌کم ۱۸۰ روز پیش از دسترس‌پذیر شدن اعلام می‌کنیم و /v1 تا ۱۸۰ روز پس از انتشار /v2 در کنار آن کار می‌کند.

ارسال جداگانه برای هر گیرندهکپی پیوند بخش

وقتی POST /v1/transactional/send چند گیرنده در to دارد، هر گیرنده نسخهٔ جداگانه‌ای از پیام را با شناسهٔ پیام خودش دریافت می‌کند. پیام مشترکی وجود ندارد و Cc قابل مشاهده‌ای هم نیست: هیچ گیرنده‌ای نشانی بقیه را نمی‌بیند. درخواست cc یا bcc را نمی‌پذیرد. اگر لازم است همهٔ گیرنده‌ها یکدیگر را ببینند، این امکان در v1 وجود ندارد.

اندازهٔ پیوست‌هاکپی پیوند بخش

هر پیام حداکثر ۱۰ پیوست و در مجموع حداکثر 10 MiB (پس از رمزگشایی Base64) دارد. درخواست بزرگ‌تر از این حد با 400 VALIDATION_FAILED رد می‌شود. پیوست‌ها را ببینید.

دامنهٔ idempotencyکپی پیوند بخش

هدر X-Idempotency-Key فقط روی دو endpoint پذیرفته می‌شود: POST /v1/transactional/send و POST /v1/transactional/send-batch. هیچ endpoint دیگری آن را نمی‌خواند، پس تکرار هر POST دیگر ممکن است اثرش را دوباره اعمال کند. Idempotency را ببینید.