هويات المرسِل

يُرسل البريد من إحدى هويات المرسِل في الحساب: نطاق يملكه أو عنوان بريد. لا يرسل Oblic إلا من هوية موثَّقة. تتطلب إضافة الهويات وحذفها مفتاحًا يتضمن identities:manage؛ ويتطلب عرضها identities:manage أو email:send.


POST/external/v1/identities

إضافة هوية

  • اسم
    identityType
    النوع
    string
    وصف

    مطلوب: Domain أو Email بهذه الكتابة وحالة الأحرف.

  • اسم
    identity
    النوع
    string
    وصف

    مطلوب: النطاق، مثل example.com، أو العنوان، مثل orders@example.com، بحد أقصى 255 محرفًا.

  • اسم
    email
    النوع
    string
    وصف

    بالنسبة إلى Domain، مطلوب: عنوان ضمن ذلك النطاق تُرسل الهوية باسمه.

  • اسم
    displayName
    النوع
    string
    وصف

    مطلوب: اسم المرسِل، بحد أقصى 255 محرفًا، من دون < أو > أو " أو فاصل أسطر.

  • اسم
    replyTo
    النوع
    string
    وصف

    العنوان الذي تُرسل إليه الردود.

إضافة نطاق

curl -X POST https://api.oblic.app/external/v1/identities \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "identityType": "Domain",
    "identity": "example.com",
    "email": "orders@example.com",
    "displayName": "Example Store"
  }'

تحتوي الاستجابة على الهوية. بالنسبة إلى النطاق، يحتوي payload على سجلات DNS المطلوب نشرها، وكل منها سجل CNAME من key إلى value: سجلات DKIM الثلاثة لمزوّد البريد، ثم سجل Oblic الخاص.

جزء من الاستجابة

{
  "status": "success",
  "data": {
    "id": "OEM000R7ZM4Q2VXH00",
    "email": "orders@example.com",
    "displayName": "Example Store",
    "domain": "example.com",
    "verificationStatus": "PENDING",
    "sendingMode": "OWN",
    "payload": [
      { "key": "6gbrjpgwjskckoa6a5zn6fwqkn67xbtw._domainkey.example.com", "value": "6gbrjpgwjskckoa6a5zn6fwqkn67xbtw.dkim.amazonses.com" },
      { "key": "pwmp4w2fqavhvhqfsxe3ch7mhc6y3kzj._domainkey.example.com", "value": "pwmp4w2fqavhvhqfsxe3ch7mhc6y3kzj.dkim.amazonses.com" },
      { "key": "y2xbgbc34rt5t5yjzu4mktqq3e4zrl7n._domainkey.example.com", "value": "y2xbgbc34rt5t5yjzu4mktqq3e4zrl7n.dkim.amazonses.com" },
      { "key": "_9f86d081884c4d659a2feaa0c55ad015.example.com", "value": "2c26b46b68ffc68ff99b453c1d304134.qwertyui.validation.oblic.app" }
    ]
  },
  "errors": null
}

إذا كانت الهوية موجودة في الحساب بالفعل، فإن إضافتها تُرجع حالتها الحالية. يُحذف الحقل الذي لا يحمل قيمة من الاستجابة.


توثيق الهوية

  • يُوثَّق النطاق بعد نشر سجلات DNS الخاصة به: سجلات DKIM التي يستخدمها المزوّد لتوقيع البريد، وسجل Oblic الذي يثبت أن النطاق يخص الحساب. يمكن الإرسال من أي عنوان ضمن نطاق موثَّق.
  • يتلقى العنوان رابطًا من مزوّد البريد يفتحه مالكه. يمكنه الإرسال عندما يُوثَّق نطاقه أيضًا كهوية نطاق للحساب.
  • لا يستطيع عنوان لدى خدمة بريد عامة مثل Gmail أو Outlook نشر سجلات، ولا يجتاز البريد المرسل باسمه عبر مزوّد آخر عمليات التحقق. لذلك يرسله Oblic عبر خدمته، مع ضبط sendingMode على OBLIC: من نطاق إرسال Oblic، باسم «اسمك via Oblic»، وتُوجَّه الردود إلى العنوان الأصلي. يرسل Oblic إلى العنوان رابطًا لتأكيد الملكية صالحًا لمدة 72 ساعة؛ ولا يمكن للهوية الإرسال قبل فتحه. لا يمكن إضافة نطاق خدمة بريد عامة بوصفه Domain. يتطلب هذا الوضع إعداد نطاق إرسال Oblic؛ وإلا يُرفض العنوان بالرمز PUBLIC_MAILBOX_DOMAIN.
  • لا يمكن أن تكون نطاقات Oblic الخاصة هوية لأي حساب.

تكون قيمة verificationStatus هي SUCCESS عندما تستطيع الهوية الإرسال، وPENDING حتى ذلك الحين.

الرفضcdالحالة
400INVALID_IDENTITYهوية Email ليست عنوان بريد، أو قيمة email لنطاق لا تنتمي إلى ذلك النطاق
400PUBLIC_MAILBOX_DOMAINنطاق خدمة بريد عامة، مثل gmail.com، مضاف بوصفه Domain، أو هوية Email عامة عندما لا يكون نطاق إرسال Oblic مُعدًّا
400OBLIC_DOMAINأحد نطاقات Oblic الخاصة
400IDENTITY_LIMIT_REACHEDبلغ مزوّد البريد الحد الأقصى المسموح به لعدد الهويات
503EMAIL_PROVIDER_UNAVAILABLEتعذّر الوصول إلى مزوّد البريد؛ أعد المحاولة

GET/external/v1/identities

عرض الهويات

هويات الحساب، مع عرض ما وُثِّق منها قبل الاستدعاء أولًا. يعيد العرض أيضًا التحقق من الهويات المعلّقة، وتُدرَج الهوية التي يوثّقها هذا التحقق بالحالة SUCCESS في الاستجابة نفسها.


DELETE/external/v1/identities/{identityId}

حذف هوية

تتوقف الهوية عن الإرسال، وينتهي معها تأكيد العنوان الذي يُرسل عبر Oblic: إذا أُضيف مجددًا، فيجب تأكيده مجددًا. تكون الاستجابة 200 سواء كانت الهوية موجودة في الحساب أم لا.

هل كانت هذه الصفحة مفيدة؟