هل تحتاج إلى مستندات ببيانات ومفاتيح حقيقية؟
ما عليك سوى الاشتراك أو تسجيل الدخول لتعبئة مفاتيح واجهة برمجة التطبيقات وبيانات الحساب الحقيقية أدناه.
لقد أنشأنا واجهة برمجة تطبيقات للوصول الآلي إلى النطاقات والأسماء المستعارة والمزيد.
وثائق API
وصول آلي إلى بياناتكواجهة برمجة تطبيقات إعادة توجيه البريد الإلكتروني
جدول المحتويات
مكتبات
في الوقت الحالي ، لم نصدر بعد أي أغلفة API ، ولكننا نخطط للقيام بذلك في المستقبل القريب. إرسال بريد إلكتروني إلىapi@forwardemail.net إذا كنت ترغب في أن يتم إعلامك عند إصدار غلاف واجهة برمجة التطبيقات للغة برمجة معينة. في غضون ذلك ، يمكنك استخدام مكتبات طلبات HTTP الموصى بها في تطبيقك ، أو ببساطة استخدامهالفة كما في الأمثلة أدناه.
| لغة | مكتبة |
|---|---|
| روبي | فاراداي |
| بيثون | الطلبات |
| جافا | حسنًا |
| بي أتش بي | أسرف في الشراب |
| جافا سكريبت | وكيل فائق |
| Node.js | وكيل فائق |
| اذهب | صافي / http |
| .شبكة | ريست شارب |
URI الأساسي
مسار URI الأساسي HTTP الحالي هو:https://api.forwardemail.net. مسار URI الأساسي HTTP القديم لـhttps://forwardemail.net:4000 تم إيقاف العمل به اعتبارًا من 1 يناير 2021.
المصادقة
تتطلب جميع نقاط النهاية الخاصة بكAPI key to be set as the "username" value of the request's التفويض الأساسي العنوان. لا تقلق - يتم تقديم أمثلة أدناه لك إذا لم تكن متأكدًا من هذا.
أخطاء
في حالة حدوث أي أخطاء ، سيتضمن نص الاستجابة لطلب واجهة برمجة التطبيقات رسالة خطأ مفصلة.
| الشفرة | اسم |
|---|---|
| 200 | حسنا |
| 400 | اقتراح غير جيد |
| 401 | غير مصرح |
| 403 | ممنوع |
| 404 | غير معثور عليه |
| 429 | طلبات كثيرة جدا |
| 500 | خطأ في الخادم الداخلي |
| 501 | لم تنفذ |
| 502 | مدخل خاطأ |
| 503 | الخدمة غير متوفرة |
| 504 | غمازة |
الموقع
تتم ترجمة خدمتنا إلى أكثر من 25 لغة مختلفة. تتم ترجمة جميع رسائل استجابة واجهة برمجة التطبيقات (API) إلى آخر لغة تم اكتشافها للمستخدم الذي يقوم بطلب واجهة برمجة التطبيقات. يمكنك تجاوز هذا عن طريق تمرير مخصصAccept-Language العنوان. لا تتردد في تجربتها باستخدام القائمة المنسدلة للغة في أسفل هذه الصفحة.
ترقيم الصفحات
إذا كنت تريد أن يتم إعلامك عند توفر ترقيم الصفحات ، فيرجى إرسال بريد إلكترونيapi@forwardemail.net.
الحساب
إنشاء حساب
POST /v1/account
| معلمة الجسم | مطلوب | نوع | وصف |
|---|---|---|---|
email |
نعم | سلسلة (البريد الإلكتروني) | عنوان بريد الكتروني |
password |
نعم | خيط | كلمه السر |
طلب مثال:
curl -X POST https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
استرجاع الحساب
GET /v1/account
طلب مثال:
curl -X GET https://api.forwardemail.net/v1/account \
-u API_TOKEN:
تحديث الحساب
PUT /v1/account
| معلمة الجسم | مطلوب | نوع | وصف |
|---|---|---|---|
email |
لا | سلسلة (البريد الإلكتروني) | عنوان بريد الكتروني |
given_name |
لا | خيط | الاسم الاول |
family_name |
لا | خيط | الكنية |
avatar_url |
لا | سلسلة (URL) | رابط للصورة الرمزية |
طلب مثال:
curl -X PUT https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
المجالات
/v1/domains/:domain_name as their path are interchangeable with a domain's ID :domain_id. This means you can refer to the domain by either its name or id value.
قائمة المجالات
GET /v1/domains
| معلمة Querystring | مطلوب | نوع | وصف |
|---|---|---|---|
name |
لا | سلسلة (RegExp مدعومة) | ابحث عن المجالات بالاسم |
alias |
لا | سلسلة (RegExp مدعومة) | ابحث عن المجالات حسب الاسم المستعار |
recipient |
لا | سلسلة (RegExp مدعومة) | البحث عن المجالات حسب المستلم |
طلب مثال:
curl -X GET https://api.forwardemail.net/v1/domains \
-u API_TOKEN:
إنشاء مجال
POST /v1/domains
| معلمة الجسم | مطلوب | نوع | وصف |
|---|---|---|---|
domain |
نعم | سلسلة (FQDN أو IP) | اسم المجال المؤهل بالكامل ("FQDN") أو عنوان IP |
plan |
لا | السلسلة (قابلة للتعداد) | نوع الخطة (يجب أن تكون"free"،"enhanced_protection"أو"team"، التخلف عن"free" or the user's current paid plan if on one) |
catchall |
لا | سلسلة (عناوين بريد إلكتروني محددة) أو منطقية | أنشئ اسمًا مستعارًا افتراضيًا شاملاً ، وافتراضيًا إلىtrue (إذاtrue سيستخدم عنوان البريد الإلكتروني لمستخدم واجهة برمجة التطبيقات كمستلم ، وإذا كانfalse لن يتم إنشاء كل شيء). إذا تم تمرير سلسلة ، فستكون قائمة محددة بعناوين البريد الإلكتروني لاستخدامها كمستلمين (مفصولة بفاصل أسطر و / أو مسافة و / أو فاصلة) |
has_adult_content_protection |
لا | منطقي | Whether to enable Spam Scanner adult content protection on this domain |
has_phishing_protection |
لا | منطقي | Whether to enable Spam Scanner phishing protection on this domain |
has_executable_protection |
لا | منطقي | Whether to enable Spam Scanner executable protection on this domain |
has_virus_protection |
لا | منطقي | Whether to enable Spam Scanner virus protection on this domain |
has_recipient_verification |
لا | منطقي | Global domain default for whether to require alias recipients to click an email verification link for emails to flow through |
طلب مثال:
curl -X POST https://api.forwardemail.net/v1/domains \
-u API_TOKEN: \
-d domain=example.com \
-d plan=free
استرجاع المجال
GET /v1/domains/example.com
طلب مثال:
curl -X GET https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
تحقق من سجلات المجال
GET /v1/domains/example.com/verify-records
طلب مثال:
curl -X GET https://api.forwardemail.net/v1/domains/example.com/verify-records \
-u API_TOKEN:
تحديث المجال
PUT /v1/domains/example.com
| معلمة الجسم | مطلوب | نوع | وصف |
|---|---|---|---|
smtp_port |
لا | سلسلة أو رقم | منفذ مخصص لتكوين إعادة توجيه SMTP (الافتراضي هو"25") |
has_adult_content_protection |
لا | منطقي | Whether to enable Spam Scanner adult content protection on this domain |
has_phishing_protection |
لا | منطقي | Whether to enable Spam Scanner phishing protection on this domain |
has_executable_protection |
لا | منطقي | Whether to enable Spam Scanner executable protection on this domain |
has_virus_protection |
لا | منطقي | Whether to enable Spam Scanner virus protection on this domain |
has_recipient_verification |
لا | منطقي | Global domain default for whether to require alias recipients to click an email verification link for emails to flow through |
طلب مثال:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
حذف المجال
DELETE /v1/domains/:domain_name
طلب مثال:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
-u API_TOKEN:
تدعو
قبول دعوة المجال
GET /v1/domains/:domain_name/invites
طلب مثال:
curl -X GET https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
إنشاء دعوة المجال
POST /v1/domains/example.com/invites
| معلمة الجسم | مطلوب | نوع | وصف |
|---|---|---|---|
email |
نعم | سلسلة (البريد الإلكتروني) | عنوان البريد الإلكتروني لدعوته إلى قائمة أعضاء المجال |
group |
نعم | السلسلة (قابلة للتعداد) | مجموعة لإضافة المستخدم إلى عضوية المجال مع (يمكن أن يكون أحد"admin" أو"user") |
طلب مثال:
curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
-u API_TOKEN: \
-d "email=user%40gmail.com" \
-d group=admin
إزالة دعوة المجال
DELETE /v1/domains/:domain_name/invites
| معلمة الجسم | مطلوب | نوع | وصف |
|---|---|---|---|
email |
نعم | سلسلة (البريد الإلكتروني) | عنوان البريد الإلكتروني لإزالته من قائمة أعضاء المجال |
طلب مثال:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
أفراد
تحديث عضو المجال
PUT /v1/domains/example.com/members/:member_id
| معلمة الجسم | مطلوب | نوع | وصف |
|---|---|---|---|
group |
نعم | السلسلة (قابلة للتعداد) | مجموعة لتحديث المستخدم إلى عضوية المجال مع (يمكن أن يكون أحد"admin" أو"user") |
طلب مثال:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
-u API_TOKEN:
إزالة عضو المجال
DELETE /v1/domains/:domain_name/members/:member_id
طلب مثال:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
-u API_TOKEN:
اسماء مستعارة
سرد أسماء النطاقات المستعارة
GET /v1/domains/example.com/aliases
| معلمة Querystring | مطلوب | نوع | وصف |
|---|---|---|---|
name |
لا | سلسلة (RegExp مدعومة) | البحث عن الأسماء المستعارة في المجال بالاسم |
recipient |
لا | سلسلة (RegExp مدعومة) | البحث عن الأسماء المستعارة في المجال عن طريق المستلم |
طلب مثال:
curl -X GET https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
إنشاء اسم نطاق مستعار جديد
POST /v1/domains/example.com/aliases
| معلمة الجسم | مطلوب | نوع | وصف |
|---|---|---|---|
name |
نعم | خيط | اسم مستعار |
recipients |
نعم | سلسلة أو صفيف | قائمة المستلمين (يجب أن تكون فاصل السطر / مسافة / سلسلة مفصولة بفواصل أو صفيف من عناوين البريد الإلكتروني الصالحة ، وأسماء النطاقات المؤهلة بالكامل ("FQDN") ، و / أو عناوين IP ، و / أو عناوين URL الخاصة بشبكة الويب) |
description |
لا | خيط | وصف الاسم المستعار |
labels |
لا | سلسلة أو صفيف | قائمة التسميات (يجب أن تكون فاصل السطر / مسافة / سلسلة مفصولة بفواصل أو صفيف) |
has_recipient_verification |
لا | منطقي | Whether to enable to require recipients to click an email verification link for emails to flow through (defaults to the domain's setting if not explicitly set in the request body) |
is_enabled |
لا | منطقي | ما إذا كان سيتم تمكين هذا الاسم المستعار (إذا تم تعطيله ، فلن يتم توجيه رسائل البريد الإلكتروني في أي مكان ولكن سيتم عرض رموز الحالة الناجحة) |
طلب مثال:
curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
استرجاع اسم النطاق المستعار
يمكنك استرداد اسم نطاق مستعار إما من خلالid أو لهاname القيمة.
GET /v1/domains/:domain_name/aliases/:alias_id
طلب مثال:
curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
-u API_TOKEN:
GET /v1/domains/:domain_name/aliases/:alias_name
طلب مثال:
curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
-u API_TOKEN:
تحديث اسم النطاق المستعار
PUT /v1/domains/example.com/aliases/:alias_id
| معلمة الجسم | مطلوب | نوع | وصف |
|---|---|---|---|
name |
لا | خيط | اسم مستعار |
recipients |
نعم | سلسلة أو صفيف | قائمة المستلمين (يجب أن تكون فاصل السطر / مسافة / سلسلة مفصولة بفواصل أو صفيف من عناوين البريد الإلكتروني الصالحة ، وأسماء النطاقات المؤهلة بالكامل ("FQDN") ، و / أو عناوين IP ، و / أو عناوين URL الخاصة بشبكة الويب) |
description |
لا | خيط | وصف الاسم المستعار |
labels |
لا | سلسلة أو صفيف | قائمة التسميات (يجب أن تكون فاصل السطر / مسافة / سلسلة مفصولة بفواصل أو صفيف) |
has_recipient_verification |
لا | منطقي | Whether to enable to require recipients to click an email verification link for emails to flow through (defaults to the domain's setting if not explicitly set in the request body) |
is_enabled |
لا | منطقي | ما إذا كان سيتم تمكين هذا الاسم المستعار (إذا تم تعطيله ، فلن يتم توجيه رسائل البريد الإلكتروني في أي مكان ولكن سيتم عرض رموز الحالة الناجحة) |
طلب مثال:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
-u API_TOKEN:
حذف اسم النطاق المستعار
DELETE /v1/domains/:domain_name/aliases/:alias_id
طلب مثال:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
-u API_TOKEN: