إنتقل إلى المحتوى الرئيسي

مرجع الـ API

Quranic CMS API هي واجهة REST لبيانات تلاوات القرآن الكريم — القراء، التلاوات، الروايات، القراءات، وتوقيتات الآيات الصوتية من ناشرين موثَّقين. عنوان URL الأساسي: https://staging.api.cms.itqan.dev.

روابط سريعة

البداية السريعةأجرِ أول استدعاء للـ API في أقل من دقيقة
أدلة الواجهات البرمجيةاتفاقيات التصميم، التصفيح، التوطين، والمزيد
المصادقةنقاط نهاية OAuth 2 للعمليات المتميزة

الاتفاقيات

  • هيكل الاستجابةهيكل الاستجابة: جميع واجهات القوائم تُعيد {count, results}.
  • التصفيحالتصفيح: معاملَا page وpage_size، الافتراضي 20، الحد الأقصى 1000.
  • التوطينالتوطين: أرسل Accept-Language: ar للنص العربي في جميع حقول الاسم والسيرة.
  • الأخطاءمعالجة الأخطاء: كل استجابة غير 2xx تستخدم {error_name, message, extra}.

مجموعات الموارد

القراء — قراء القرآن الموثَّقون مع الاسم والسيرة وعدد التلاوات. ابدأ بـ قائمة القراء.

التلاوات — سجلات التلاوة الكاملة التي تربط قارئاً ورواية وقراءة وناشراً. تتضمن أعداد المسارات على مستوى السور. ابدأ بـ قائمة التلاوات.

مسارات التلاوة — إدخالات المسار الصوتي على مستوى السورة لتلاوة معينة، بما في ذلك توقيتات الآيات. ابدأ بـ قائمة مسارات التلاوة.

الروايات — سلاسل الرواية (مثل حفص عن عاصم، ورش). ابدأ بـ قائمة الروايات.

المصادقة — إصدار التوكنات وإلغاؤها للعمليات المُصادق عليها. راجع دليل المصادقة.