توافق واجهة API

التزام الإصداراتنسخ رابط القسم

يُحدَّد إصدار واجهة API في مسار URL. حاليًا لا يوجد سوى /v1.

• تغييرات v1 إضافية فقط. نضيف نقاط نهاية (endpoints) وحقول طلب اختيارية وحقول استجابة وأنواع أحداث. لا نحذف حقلًا ولا نغيّر اسمه ولا معناه، ولا نجعل حقلًا اختياريًا إلزاميًا. على عميلك تجاهل حقول الاستجابة التي لا يعرفها.
• يصدر التغيير غير المتوافق باسم /v2. نعلن عنه قبل 180 يومًا على الأقل من توفره، ويستمر /v1 بالعمل بالتوازي مع /v2 لمدة 180 يومًا بعد إصدار /v2.

نسخة منفصلة لكل مستلمنسخ رابط القسم

عندما يتضمن POST /v1/transactional/send عدة مستلمين في to، يتلقى كل مستلم نسخة منفصلة من الرسالة بمعرّف رسالة خاص به. لا توجد رسالة مشتركة ولا يوجد Cc مرئي: لا يرى أي مستلم عناوين الآخرين. لا يقبل الطلب الحقلين cc وbcc. إذا كنت تحتاج أن يرى كل المستلمين بعضهم بعضًا، فهذا غير متاح في v1.

حجم المرفقاتنسخ رابط القسم

تحمل الرسالة 10 مرفقات كحد أقصى، وبحد أقصى 10 MiB إجمالًا بعد فك ترميز Base64. يُرفض الطلب الذي يتجاوز الحد برمز 400 VALIDATION_FAILED. راجع المرفقات.

نطاق idempotencyنسخ رابط القسم

يُقبل الترويس X-Idempotency-Key على نقطتي نهاية فقط: POST /v1/transactional/send وPOST /v1/transactional/send-batch. لا تقرؤه أي نقطة نهاية أخرى، لذا قد تكرر إعادة أي طلب POST آخر أثره. راجع Idempotency.