وثائق API

مرحبًا بك في وثائق NonMail API! تسمح لك هذه API بإنشاء وإدارة عناوين البريد الإلكتروني المؤقتة برمجيًا.

نقاط النهاية API

تم تصميم API الخاص بنا ليكون بسيطًا وسهل الاستخدام. جميع نقاط النهاية متاحة عبر https://api.nonmail.com/v1/

POST/v1/email/create

إنشاء عنوان بريد إلكتروني مؤقت جديد

ينشئ عنوان بريد إلكتروني مؤقت جديد.

نص الطلب:

json

{{
  "duration": 300,
  "prefix": "my-temp-mail"
}}

الاستجابة:

json

{{
  "status": "success",
  "email": "my-temp-mail_12345@nonmail.com",
  "token": "your_access_token",
  "expires_at": 1678886400
}}

GET/v1/email/inbox

الحصول على رسائل لعنوان

استرداد جميع الرسائل المستلمة لعنوان بريد إلكتروني مؤقت محدد.

الرؤوس:

bash

Authorization: Bearer your_access_token

الاستجابة:

json

{{
  "status": "success",
  "emails": [
    {{
      "id": "email_id_1",
      "from": "sender@example.com",
      "subject": "مرحبًا من NonMail",
      "body_preview": "هذه معاينة لمحتوى البريد الإلكتروني...",
      "received_at": 1678885000
    }}
  ]
}}

GET/v1/email/message/email_id_1

الحصول على رسالة محددة

استرداد المحتوى الكامل لرسالة محددة.

الرؤوس:

bash

Authorization: Bearer your_access_token

الاستجابة:

json

{{
  "status": "success",
  "id": "email_id_1",
  "from": "sender@example.com",
  "subject": "مرحبًا من NonMail",
  "body": "<html><body><p>محتوى البريد الإلكتروني الكامل هنا.</p></body></html>",
  "received_at": 1678885000
}}

المصادقة

تتطلب جميع نقاط النهاية المصادقة عليها رمز API يتم الحصول عليه عند إنشاء بريد إلكتروني جديد. مرر هذا الرمز في رأس Authorization كرمز Bearer.

bash

Authorization: Bearer your_access_token

معالجة الأخطاء

يستخدم API الخاص بنا رموز حالة HTTP القياسية للإشارة إلى نجاح أو فشل طلب API.

200 نجحكان الطلب ناجحًا.

400 طلب خاطئكان الطلب معيبًا أو غير صالح.

401 غير مخولرمز API مفقود أو غير صالح.

404 غير موجودلا يمكن العثور على المورد المطلوب.

500 خطأ في الخادم الداخليحدث خطأ من جانبنا.

حدود المعدل

لضمان الاستخدام العادل، نطبق حدود المعدل. حاليًا، يُسمح لك بـ 100 طلب في الدقيقة لكل عنوان IP. تجاوز هذا الحد سيؤدي إلى خطأ 429 Too Many Requests.

دعم اللغة

وثائق API متاحة بـ 8 لغات. يمكنك تحديد اللغة المطلوبة عن طريق تعيين رأس Accept-Language في طلبات API الخاصة بك، أو عن طريق اختيارها في صفحة الوثائق.

مثال: Accept-Language: ar للعربية.

bash

Accept-Language: ar

الدعم

إذا كان لديك أي أسئلة أو واجهت مشاكل، يرجى الاتصال بفريق الدعم لدينا على support@nonmail.com.

مثال على الاستخدام

إليك مثال كامل لكيفية استخدام API مع curl:

bash

curl -X POST https://api.nonmail.com/v1/email/create \
  -H "Content-Type: application/json" \
  -d '{{
    "duration": 300,
    "prefix": "my-temp-mail"
  }}'