v1

واجهة برمجة التطبيقات

واجهة برمجة تطبيقات عامة ومفتوحة تمكنك من الوصول إلى مكتبة النماذج العربية برمجياً. مثالية لبناء تطبيقات ومواقع تعتمد على النماذج الجاهزة.

REST API سريع
عام - بدون مصادقة
100 طلب/دقيقة

المصادقة

المصادقة

جميع نقاط النهاية في الإصدار v1 عامة ولا تتطلب مصادقة. قد نضيف مصادقة اختيارية في إصدارات مستقبلية.

لا تتطلب مصادقة

رأس المصادقة (مستقبلي)

عند إضافة المصادقة، ستستخدم رأس Bearer Token كما يلي:

http
Authorization: Bearer YOUR_API_KEY
Accept: application/json

حد السرعة

100

طلب لكل عنوان IP في الدقيقة

429

رمز الاستجابة عند تجاوز الحد

60

ثانية - مدة إعادة تعيين النافذة

رؤوس تحديد المعدل

http
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 87
X-RateLimit-Reset: 1700000000

# On 429 response:
Retry-After: 32
الرأسالوصف
X-RateLimit-Limitالحد الأقصى للطلبات المسموح بها في النافذة الزمنية
X-RateLimit-Remainingعدد الطلبات المتبقية في النافذة الحالية
X-RateLimit-Resetالوقت (Unix timestamp) الذي تُعاد فيه تعيين النافذة
Retry-Afterيظهر فقط مع 429 - عدد الثواني قبل إعادة المحاولة

عنوان الأساس

text
https://go.drmohamedelmahdi.com/templates/api/v1

نقاط النهاية

GET/api/v1/templates

قائمة النماذج

الحصول على قائمة بجميع النماذج مع إمكانية التصفية والبحث والترتيب والصفحات

مثال cURL

bash
curl -X GET "https://go.drmohamedelmahdi.com/templates/api/v1/templates?page=1&limit=10&sort=newest" \
  -H "Accept: application/json"
GET/api/v1/templates/{slug}

تفاصيل نموذج

الحصول على نموذج واحد بتفاصيله الكاملة بما في ذلك النسخة المفصلة والنصائح والأسئلة الشائعة

مثال cURL

bash
curl -X GET "https://go.drmohamedelmahdi.com/templates/api/v1/templates/official-request-letter" \
  -H "Accept: application/json"
GET/api/v1/categories

قائمة التصنيفات

الحصول على قائمة بجميع التصنيفات المتاحة مع عدد النماذج في كل تصنيف

مثال cURL

bash
curl -X GET "https://go.drmohamedelmahdi.com/templates/api/v1/categories" \
  -H "Accept: application/json"
GET/api/v1/search

بحث في النماذج

البحث في النماذج عبر العنوان والعنوان الإنجليزي والوصف والوسوم واسم التصنيف

مثال cURL

bash
curl -X GET "https://go.drmohamedelmahdi.com/templates/api/v1/search?q=%D8%AE%D8%B7%D8%A7%D8%A8&category=official-letters" \
  -H "Accept: application/json"
POST/api/newsletter/subscribe

اشتراك في النشرة البريدية

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

مثال cURL

bash
curl -X POST "https://go.drmohamedelmahdi.com/templates/api/newsletter/subscribe" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"email": "user@example.com"}'
POST/api/newsletter/unsubscribe

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

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

مثال cURL

bash
curl -X POST "https://go.drmohamedelmahdi.com/templates/api/newsletter/unsubscribe" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"email": "user@example.com"}'
GET/api/newsletter/status

حالة الاشتراك

التحقق من حالة اشتراك بريد حسابك الحالي، ويتطلب تسجيل الدخول

مثال cURL

bash
curl -X GET "https://go.drmohamedelmahdi.com/templates/api/newsletter/status?email=user@example.com" \
  -H "Accept: application/json" \
  -H "Cookie: next-auth.session-token=YOUR_SESSION_TOKEN"

رموز الأخطاء

200

نجاح

نجاح - تم إرجاع البيانات المطلوبة

201

تم الإنشاء

تم الإنشاء - تم إنشاء مورد جديد بنجاح

400

طلب غير صالح

طلب غير صالح - معاملات مفقودة أو غير صحيحة

404

غير موجود

غير موجود - المورد المطلوب غير موجود

409

تعارض

تعارض - المورد موجود مسبقاً

429

طلبات كثيرة جداً

تجاوز حد السرعة - انتظر قبل المحاولة مرة أخرى

500

خطأ في الخادم

خطأ في الخادم - خطأ داخلي في الخادم

مثال على استجابة تجاوز الحد (429)

json
{
  "error": "Too Many Requests",
  "message": "تجاوزت حد الطلبات المسموح بها. يرجى المحاولة بعد 32 ثانية.",
  "retryAfter": 32
}

واجهة النشرة البريدية

الاشتراك وإلغاؤه متاحان دون تسجيل دخول مع استجابات تحمي الخصوصية، بينما يتطلب فحص الحالة حسابًا مسجلًا يطابق البريد المطلوب.

json
{
  "subscribe": "POST /api/newsletter/subscribe  { email: string }",
  "unsubscribe": "POST /api/newsletter/unsubscribe  { email: string }",
  "checkStatus": "GET /api/newsletter/status?email=example@mail.com"
}

واجهة برمجة التطبيقات v1 • نماذج جاهزة | Template Wise • جميع الاستجابات بصيغة JSON