التوثيق/المصادقة

المصادقة

تتطلب جميع طلبات API مفتاح API صالحًا يُمرَّر كرمز Bearer.

عرض Markdown OpenAPI JSON

رمز Bearer

أجروا المصادقة بتضمين مفتاح API الخاص بكم في ترويسة Authorization في كل طلب:

http
Authorization: Bearer YOUR_API_KEY

مفتاح API الخاص بكم سلسلة طويلة تبدأ بـ ev_. على سبيل المثال:

http
Authorization: Bearer ev_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

أين تجدون مفتاح API الخاص بكم

  1. سجّلوا الدخول إلى حسابكم على verimails.com/dashboard
  2. انتقلوا إلى الإعدادات ← مفاتيح API
  3. انسخوا مفتاحكم
⚠️
حافظوا على سرية مفتاح API الخاص بكم. لا تضمّنوه أبدًا في JavaScript من جهة العميل أو في مستودعات عامة، ولا تشاركوه مع جهات غير موثوقة. وإذا تعرّض للاختراق، فأعيدوا إنشاءه فورًا من لوحة التحكم.

مثال على طلب مُصادَق عليه

bash
curl -X POST https://verimails.com/api/verify/single \
  -H "Authorization: Bearer ev_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"email": "test@example.com"}'

أخطاء المصادقة

إذا كان مفتاحكم مفقودًا أو غير صالح، فستتلقون استجابة 401 Unauthorized :

json
{
  "error": "Unauthorized",
  "message": "Invalid or missing API key",
  "status_code": 401
}
ℹ️
هل تحتاجون إلى عدة مفاتيح API لبيئات أو تطبيقات مختلفة؟ يمكنكم إنشاء مفاتيح إضافية من لوحة التحكم.