مستندات واجهة برمجة تطبيقات التحقق من صحة البريد الإلكتروني
الشروع في العمل
تتطلب جميع طلبات واجهة برمجة التطبيقات مصادقة باستخدام مفتاح واجهة برمجة التطبيقات. يمكنك العثور على مفتاح API الخاص بك في لوحة التحكم.
الرأس: "x-api-key: your-api-keykey"التحقق الفردي
تحقق من عنوان بريد إلكتروني واحد أو نطاق واحد للتحقق من صلاحيته وحالة التخلص منه وخدمات الخصوصية وإمكانية التسليم.
نقطة النهاية
GET /v1/verifyالمعلمات
| الاسم | النوع | مطلوب | الوصف |
|---|---|---|---|
| input | string | نعم | عنوان البريد الإلكتروني أو المجال المراد التحقق منه (على سبيل المثال، [email protected] أو example.com) |
apiDocs.responseFields
| الحقل | الوصف |
|---|---|
| valid | يشير إلى ما إذا كان تنسيق البريد الإلكتروني صحيحاً أم لا |
| block | يشير إلى ما إذا كان يجب حظر البريد الإلكتروني (صواب إذا كان البريد الإلكتروني الذي يمكن التخلص منه أو الخصوصية أو ApplePrivateEmail أو قابل للتسليم أو قابل للتوصيل أو قابل للتوصيل أو قابل للتوصيل) |
| disposable | تحديد ما إذا كان عنوان البريد الإلكتروني عنوان بريد إلكتروني مؤقت أو يمكن التخلص منه |
| privacy | يحدد ما إذا كان خادم البريد يستخدم اسمًا مستعارًا للبريد الإلكتروني أو معيد توجيه البريد الإلكتروني |
| applePrivateEmail | يشير إلى ما إذا كان البريد الإلكتروني هو عنوان بريد إلكتروني خاص بشركة Apple |
| deliverable | التحقق مما إذا كان صندوق البريد موجوداً ويمكنه استقبال رسائل البريد الإلكتروني |
| domain | جزء المجال من عنوان البريد الإلكتروني |
| email_address | عنوان البريد الإلكتروني |
| catch_all | يشير إلى ما إذا كان المجال يحتوي على تكوين بريد إلكتروني شامل يقبل جميع رسائل البريد الإلكتروني الواردة بغض النظر عن عنوان المستلم |
| mx_found | يشير إلى ما إذا كان المجال يحتوي على خوادم بريد صالحة (سجلات MX) |
| remaining_credits | عدد أرصدة واجهة برمجة التطبيقات (API) المتبقية في حسابك |
مثال على الاستجابة
{
"valid": true,
"block": false,
"disposable": false,
"privacy": false,
"applePrivateEmail": false,
"deliverable": true,
"domain": "example.com",
"email_address": "[email protected]",
"catch_all": false,
"mx_found": true,
"error": null,
"remaining_credits": 99
}أمثلة على الرموز
curl "https://api.verify-email.app/v1/[email protected]" \
-H "X-API-Key: your-api-key"جربها
تحتاج إلى مفتاح API لاختبار نقاط النهاية.
جرب مع:
التحقق من الدُفعات
تحقق من عناوين بريد إلكتروني أو نطاقات بريد إلكتروني متعددة في طلب واحد (بحد أقصى 100 عنصر).
نقطة النهاية
POST /v1/verify/batchالمعلمات
| الاسم | النوع | مطلوب | الوصف |
|---|---|---|---|
| inputs | array of strings | نعم | مجموعة من عناوين البريد الإلكتروني أو المجالات للتحقق منها |
أمثلة على الرموز
curl -X POST "https://api.verify-email.app/v1/verify/batch" \
-H "Content-Type: application/json" \
-H "X-API-Key: your-api-key" \
-d '{
"inputs": [
"[email protected]",
"[email protected]"
]
}'جربها
تحتاج إلى مفتاح API لاختبار نقاط النهاية.
جرّب مع نطاقات مختلفة: