## المصادقة

تعلم كيفية الحصول على مفاتيح API واستخدامها

## الحصول على مفتاح API

قبل استخدام API، تحتاج إلى الحصول على مفتاح API. يمكنك إنشاء مفتاح API الخاص بك في صفحة الملف الشخصي.

### استخدام مفتاح API

قم بتضمين مفتاح API الخاص بك في رؤوس الطلب لجميع طلبات API:

[Code (bash)]
X-API-Key: YOUR_API_KEY
[/Code]

### ملاحظات مهمة

- احتفظ بمفتاح API الخاص بك آمناً ولا تعرضه في الأماكن العامة
- مفتاح API لديه نفس الصلاحيات مثل حسابك، استخدمه بحذر
- إذا تم اختراق مفتاح API الخاص بك، قم بإعادة إنشاء واحد جديد فوراً في صفحة الملف الشخصي

---

## API البريد الإلكتروني

إنشاء وإدارة البريد الإلكتروني

## الحصول على النطاقات المتاحة

احصل على جميع نطاقات البريد الإلكتروني المتاحة في النظام.

### الطلب

[Code (bash)]
GET /api/email/domains
[/Code]

### مثال الطلب

[Code (bash)]
curl https://chat-tempmail.com/api/email/domains \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### معاملات الاستجابة

المعامل | النوع | الوصف
--------- | ------- | --------
domains | array | قائمة نطاقات البريد الإلكتروني المتاحة

### مثال الاستجابة

[Code (json)]
{
  "domains": [
    "chat-tempmail.com",
    "example.com", 
    "other-domain.com"
  ]
}
[/Code]

## إنشاء البريد الإلكتروني

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

### الطلب

[Code (bash)]
POST /api/emails/generate
[/Code]

### معاملات الطلب

المعامل | النوع | مطلوب | الوصف
--------- | ------- | -------- | --------
name | string | نعم | بادئة البريد الإلكتروني
expiryTime | number | نعم | وقت الانتهاء (بالمللي ثانية)<br/>القيم المتاحة:<br/>- 3600000 (1 ساعة)<br/>- 86400000 (1 يوم)<br/>- 259200000 (3 أيام)<br/>- 0 (دائم)
domain | string | نعم | نطاق البريد الإلكتروني

### مثال الطلب

[Code (bash)]
curl -X POST https://chat-tempmail.com/api/emails/generate \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "test",
    "expiryTime": 3600000,
    "domain": "chat-tempmail.com"
  }'
[/Code]

### معاملات الاستجابة

المعامل | النوع | الوصف
--------- | ------- | --------
id | string | المعرف الفريد للبريد الإلكتروني (تنسيق UUID)
email | string | عنوان البريد الإلكتروني المُنشأ (عنوان البريد الإلكتروني الكامل)

### مثال الاستجابة

[Code (json)]
{
  "id": "c2c4f894-c672-4d5b-a918-abca95aff1f7",
  "email": "test@chat-tempmail.com"
}
[/Code]

## الحصول على قائمة البريد الإلكتروني

احصل على جميع عناوين البريد الإلكتروني تحت حسابك.

### الطلب

[Code (bash)]
GET /api/emails
[/Code]

### معاملات الطلب

المعامل | النوع | مطلوب | الوصف
--------- | ------- | -------- | --------
cursor | string | لا | مؤشر الترقيم، احصل على nextCursor من الاستجابة السابقة

### مثال الطلب

[Code (bash)]
curl https://chat-tempmail.com/api/emails \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### معاملات الاستجابة

المعامل | النوع | الوصف
--------- | ------- | --------
emails | array | قائمة البريد الإلكتروني (الحد الأقصى 20 عنصر لكل طلب)
nextCursor | string | مؤشر الصفحة التالية للحصول على المزيد من البيانات
total | number | العدد الإجمالي للبريد الإلكتروني

### كائنات البريد الإلكتروني في مصفوفة emails

المعامل | النوع | الوصف
--------- | ------- | --------
id | string | المعرف الفريد للبريد الإلكتروني (تنسيق UUID)
address | string | عنوان البريد الإلكتروني (عنوان البريد الإلكتروني الكامل)
userId | string | معرف المستخدم الذي يملك البريد الإلكتروني (تنسيق UUID)
createdAt | string | وقت إنشاء البريد الإلكتروني (تنسيق ISO 8601)
expiresAt | string | وقت انتهاء البريد الإلكتروني (تنسيق ISO 8601)

### مثال الاستجابة

[Code (json)]
{
  "emails": [
    {
      "id": "e4ff5c14-8a72-48c5-bd13-b5347fb944da",
      "address": "6Tg3VT@chat-tempmail.com",
      "userId": "bd08008d-e944-44b2-a0d0-67f2b528ee6d",
      "createdAt": "2025-04-21T08:30:45.084Z",
      "expiresAt": "2025-04-22T08:30:45.084Z"
    }
  ],
  "nextCursor": "fd13a8df-1465-4fbc-a612-ca7311c31ff2",
  "total": 20
}
[/Code]

## حذف البريد الإلكتروني

حذف عنوان البريد الإلكتروني المحدد.

### الطلب

[Code (bash)]
DELETE /api/emails/{emailId}
[/Code]

### معاملات الطلب

المعامل | النوع | مطلوب | الوصف
--------- | ------- | -------- | --------
emailId | string | نعم | معرف البريد الإلكتروني (معامل المسار)

### مثال الطلب

[Code (bash)]
curl -X DELETE "https://chat-tempmail.com/api/emails/99fadf12-6826-490a-9c6c-b0b528d4a8e0" \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### معاملات الاستجابة

المعامل | النوع | الوصف
--------- | ------- | --------
success | boolean | ما إذا كان الحذف ناجحاً

### مثال الاستجابة

[Code (json)]
{
  "success": true
}
[/Code]

---

## API الرسائل

إدارة الرسائل

## الحصول على قائمة الرسائل

احصل على جميع الرسائل في عنوان البريد الإلكتروني المحدد.

### الطلب

[Code (bash)]
GET /api/emails/{emailId}
[/Code]

### معاملات الطلب

المعامل | النوع | مطلوب | الوصف
--------- | ------- | -------- | --------
emailId | string | نعم | معرف البريد الإلكتروني (معامل المسار)
cursor | string | لا | مؤشر الترقيم (معامل الاستعلام)، احصل على nextCursor من الاستجابة السابقة

### مثال الطلب

[Code (bash)]
curl "https://chat-tempmail.com/api/emails/c2c4f894-c672-4d5b-a918-abca95aff1f7" \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### معاملات الاستجابة

المعامل | النوع | الوصف
--------- | ------- | --------
messages | array | قائمة الرسائل (الحد الأقصى 20 عنصر لكل طلب)
nextCursor | string | مؤشر الصفحة التالية للحصول على المزيد من البيانات
total | number | العدد الإجمالي للرسائل

### كائنات الرسائل في مصفوفة messages

المعامل | النوع | الوصف
--------- | ------- | --------
id | string | المعرف الفريد للرسالة (تنسيق UUID)
from_address | string | عنوان المرسل
subject | string | موضوع الرسالة
received_at | number | وقت الاستلام (طابع زمني Unix بالمللي ثانية)

### مثال الاستجابة

[Code (json)]
{
  "messages": [
    {
      "id": "fd13a8df-1465-4fbc-a612-ca7311c31ff2",
      "from_address": "sender1@example.com",
      "subject": "Test Message 1 - xJOK2h",
      "received_at": 1745224245084
    }
  ],
  "nextCursor": "eyJ0aW1lc3RhbXAiOjE3NDUxNTU4NDUwODQsImlkIjoiNjNmNzFlODYtOGE1NC00ZDQ0LTk5ZWYtN2QzNTBhMTQ4M2JiIn0=",
  "total": 50
}
[/Code]

## الحصول على تفاصيل الرسالة

احصل على المحتوى التفصيلي للرسالة المحددة.

### الطلب

[Code (bash)]
GET /api/emails/{emailId}/{messageId}
[/Code]

### معاملات الطلب

المعامل | النوع | مطلوب | الوصف
--------- | ------- | -------- | --------
emailId | string | نعم | معرف البريد الإلكتروني (معامل المسار)
messageId | string | نعم | معرف الرسالة (معامل المسار)

### مثال الطلب

[Code (bash)]
curl "https://chat-tempmail.com/api/emails/99fadf12-6826-490a-9c6c-b0b528d4a8e0/fd13a8df-1465-4fbc-a612-ca7311c31ff2" \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### معاملات الاستجابة

المعامل | النوع | الوصف
--------- | ------- | --------
message | object | تفاصيل الرسالة

### حقول كائن message

المعامل | النوع | الوصف
--------- | ------- | --------
id | string | المعرف الفريد للرسالة (تنسيق UUID)
from_address | string | عنوان المرسل
subject | string | موضوع الرسالة
content | string | محتوى الرسالة النصي العادي
html | string | محتوى الرسالة HTML (قد يكون فارغاً)
received_at | number | وقت الاستلام (طابع زمني Unix بالمللي ثانية)

### مثال الاستجابة

[Code (json)]
{
  "message": {
    "id": "fd13a8df-1465-4fbc-a612-ca7311c31ff2",
    "from_address": "sender1@example.com",
    "subject": "Test Message 1 - xJOK2h",
    "content": "Test Message 1\n\nThis is test message 1 content.\n\nBest regards,\nSender 1",
    "html": "<div>\n<h1>Test Message 1</h1>\n </div>",
    "received_at": 1745224245084
  }
}
[/Code]

## حذف الرسالة

حذف الرسالة المحددة.

### الطلب

[Code (bash)]
DELETE /api/emails/{emailId}/{messageId}
[/Code]

### معاملات الطلب

المعامل | النوع | مطلوب | الوصف
--------- | ------- | -------- | --------
emailId | string | نعم | معرف البريد الإلكتروني (معامل المسار)
messageId | string | نعم | معرف الرسالة (معامل المسار)

### مثال الطلب

[Code (bash)]
curl -X DELETE "https://chat-tempmail.com/api/emails/76d91ae5-822a-4fdd-8701-9de038ec86d7/20e77445-b0c3-4e8b-aa29-762ea423ac15" \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### معاملات الاستجابة

المعامل | النوع | الوصف
--------- | ------- | --------
success | boolean | ما إذا كان الحذف ناجحاً

### مثال الاستجابة

[Code (json)]
{
  "success": true
}
[/Code]

---

## دفع Webhook

تكوين webhook لاستقبال إشعارات دفع الرسائل

## الحصول على تكوين Webhook

احصل على معلومات تكوين webhook الحالية.

### الطلب

[Code (bash)]
GET /api/webhook
[/Code]

### مثال الطلب

[Code (bash)]
curl https://chat-tempmail.com/api/webhook \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### معاملات الاستجابة

المعامل | النوع | الوصف
--------- | ------- | --------
url | string | عنوان URL للwebhook (قد يكون سلسلة فارغة)
enabled | boolean | ما إذا كان webhook مفعلاً

### مثال الاستجابة

[Code (json)]
{
  "url": "https://your-server.com/webhook",
  "enabled": true
}
[/Code]

## تكوين Webhook

تعيين أو تحديث تكوين webhook.

### الطلب

[Code (bash)]
POST /api/webhook
[/Code]

### معاملات الطلب

المعامل | النوع | مطلوب | الوصف
--------- | ------- | -------- | --------
url | string | نعم | عنوان URL للwebhook (يجب أن يكون URL HTTP/HTTPS صالح)
enabled | boolean | نعم | ما إذا كان تفعيل webhook

### مثال الطلب

[Code (bash)]
curl -X POST https://chat-tempmail.com/api/webhook \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-server.com/webhook",
    "enabled": true
  }'
[/Code]

### معاملات الاستجابة

المعامل | النوع | الوصف
--------- | ------- | --------
success | boolean | ما إذا كان التكوين ناجحاً

### مثال الاستجابة

[Code (json)]
{
  "success": true
}
[/Code]

## أحداث Webhook

عند وصول رسالة جديدة، سيرسل النظام طلب POST إلى URL المُعد الخاص بك.

### تنسيق البيانات المستلمة

رؤوس الطلب:
- Content-Type: application/json
- X-Webhook-Event: new_message

### بيانات دفع Webhook

المعامل | النوع | الوصف
--------- | ------- | --------
emailId | string | معرف البريد الإلكتروني الذي استلم الرسالة (تنسيق UUID)
messageId | string | معرف الرسالة الجديدة (تنسيق UUID)
fromAddress | string | عنوان المرسل
subject | string | موضوع الرسالة
content | string | محتوى الرسالة النصي العادي
html | string | محتوى الرسالة HTML (قد يكون فارغاً)
receivedAt | string | وقت استلام الرسالة (تنسيق ISO 8601)
toAddress | string | عنوان البريد الإلكتروني الذي استلم الرسالة

### مثال بيانات الدفع

[Code (json)]
{
  "emailId": "c2c4f894-c672-4d5b-a918-abca95aff1f7",
  "messageId": "fd13a8df-1465-4fbc-a612-ca7311c31ff2",
  "fromAddress": "sender@example.com",
  "subject": "Test Message",
  "content": "Message plain text content",
  "html": "<div>Message HTML content</div>",
  "receivedAt": "2025-01-21T08:30:45.084Z",
  "toAddress": "test@chat-tempmail.com"
}
[/Code]

### متطلبات الاستجابة

يجب أن يعيد خادمك رمز حالة 2xx للإشارة إلى الاستلام الناجح. إذا تم إرجاع رمز حالة غير 2xx، قد يعيد النظام محاولة الإرسال.

الاستجابة الموصى بها:

[Code (json)]
HTTP/1.1 200 OK
Content-Type: application/json

{
  "received": true
}
[/Code]

### ملاحظات مهمة

- تأكد من أن URL webhook الخاص بك يمكن الوصول إليه
- يُنصح بالتحقق من سلامة بيانات الدفع على جانب الخادم الخاص بك
- سيرسل النظام دفع webhook فوراً عند وصول الرسائل
- إذا فشلت الدفعات، قد يعيد النظام المحاولة، لذا تأكد من أن واجهتك متسقة

---