توثيق بوابة رمضان

مقدمة

تعد بوابة رمضان إحدى خدمات المواقع المتخصصة في تصنيف بعينه حيث يعتني الموقع الخاص برمضان بنشر جميع المواد التي تتعلق برمضان وتصنيف الصيام في دار الإسلام وهو بداية مجموعة خدمات متنوعة متعددة تُعنى بتصنيفات هامة يحتاجها المسلمون وجاري العمل على إنشاء مواقع اخرى شبيهة مثل ( الحج - المرأة - الزكاه ..) وغيرها . يمكنك تصفح البوابة على الرابط التالي بلاغ

مكونات البنية التحتية لبوابة رمضان

جميع الروابط الخاصة ببوابة رمضان تبدأ بالرابط التالي

http://api.islamhouse.com/v1/XXXXXX/dynamic/ramadan/

جلب اللغات المتاحة بواجهة معينة

لجلب اللغات المتاحة كلغة واجهة للمواد في خدمة بلاغ يمكنك طلب الرابط التالي
http://api.islamhouse.com/v1/XXXXXXXX/dynamic/ramadan/get-all/ar/json
مع ملاحظة أنه يتم تحديد لغة الواجهة المطلوب جلب اللغات بها وفي المثال السابق تم جلب اللغات باللغة العربية حيث ان التكوين البرمجي للرابط هو
/get-all/{lang}/{format}
ولمعرفة لغات الواجهة المتاحة والتي يمكن تصفح مواد بها من خلال الرابط

http://api.islamhouse.com/v1/XXXXXXXX/dynamic/ramadan/get-available-languages/json

جلب المحتويات بلغة بعينها

لجلب المواد المتاحة بلغة واجهة معينة يتم طلب الرابط التالي

http://api.islamhouse.com/v1/XXXXXXXX/dynamic/ramadan/get-content-by-type/showall/ar/showall/1/3/json
والتكوين البرمجي للرابط السابق هو
/get-content-by-type/{type}/{flang}/{slang}/{pageNum}/{limit}/{format}

ملاحظات هامة

في المثال السابق هناك مجموعة من المتغيرات تم إدخالها للرابط وهي

type
flang
slang
pageNum
limit
format

pageNum تمثل رقم الصفحة التي تريد عرضها وغالبا تبدأ بالرقم ١ لجلب محتويات الصفحة الأولى

type يمثل نوع المواد التي تريد جلبها حيث يمكنك تحديد نوع بعينه ولمعرفة الأنواع المتاحة يمكن طلب الرابط التالي
http://api.islamhouse.com/v1/XXXXXXXXX/dynamic/ramadan/get-available-types/ar/ar/json
والتكوين البرمجي للرابط هو
/get-available-types/{flang}/{slang}/{format}
حيث أن المتغير flang يمثل لغة الواجهة للمواد التي تريد جلبها
والمتغير slang يمثل لغة المصدر للمواد التي تريد جلبها

معلومة

في لغة المصدر يمكنك إستخدام الكلمة showall بدلا من رمز اللغة ذلك لجلب جميع اللغات دون تحديد لغة بعينها فعلى سبيل المثال الرابط السابق تم جلب أنواع المواد المتاحة للمواد بلغة واجهة عربي ولغة مصدر عربي
اذا أردنا جلب جميع النواع المتاحة للغة الواجة عربي واي لغة مصدر يكون الرابط كما يلي

http://api.islamhouse.com/v1/XXXXXXXXX/dynamic/ramadan/get-available-types/ar/showall/json
لاحظ تغيير رمز اللغة من ar الي showall

لتكون النتيجة
[
  "books",
  "articles",
  "audios",
  "videos",
  "fatwa",
  "poster",
  "programsv",
  "apps",
  "cards"
]

ولجلب جميع المواد بواجهة عربي وأي لغة مصدر مع عدم تحديد نوع معين يكون الرابط

http://api.islamhouse.com/v1/XXXXXXXX/dynamic/ramadan/get-content-by-type/showall/ar/showall/1/3/json

لاحظ أننا استخدمنا كلمة showall في موضعين في الأنواع وفي لغة المصدر وغالبا هذا الأسلوب معتمد في كل روابط البنية التحتية في دار الإسلام

حيث أن التكوين البرمجي للرابط السابق هو
/get-content-by-type/{type}/{flang}/{slang}/{pageNum}/{limit}/{format}

مع ملاحظه انه تم تحديد العدد المطلوب جلبه ٣ عناصر فقط والحد الأقصى للعدد في كل صفحة هو ٥٠


{
links: {
    next: "http://api.islamhouse.com/v1/paV29H2gm56kvLPy/dynamic/ramadan/get-content-by-type/showall/ar/showall/2/3/json/",
    prev: "",
    first: "http://api.islamhouse.com/v1/paV29H2gm56kvLPy/dynamic/ramadan/get-content-by-type/showall/ar/showall/1/3/json/",
    last: "http://api.islamhouse.com/v1/paV29H2gm56kvLPy/dynamic/ramadan/get-content-by-type/showall/ar/showall/711/3/json/",
    current_page: 1,
    pages_number: 711,
    total_items: 2133
    },
data: [
  {
    id: 2769681,
    source_id: 2769680,
    title: "إني صائم",
    description: "مقالة باللغة الفارسية وصفَ فيها الشيخ - حفظه الله - أحوالَ السلف الصالح في استقبالهم لشهر رمضان، وكيف كانت عباداتهم فيه، وذكر الأدلة الشرعية على وجوب اغتنام هذا الشهر في الطاعات والحسنات.",
    full_description: null,
    add_date: 1439814960,
    type: "articles",
    image: null,
  prepared_by: [
    {
    id: 77402,
    source_id: 77402,
    title: "محمد بن عبد الرحمن العريفي",
    kind: "author",
    type: "author",
    description: "محمد بن عبد الرحمن العريفي: أستاذ مساعد في العقيدة والمذاهب المعاصرة بقسم الدراسات الإسلامية - كلية المعلمين بجامعة الملك سعود. وموقعه الرسمي: www.arefe.com"
    },
  {
    id: 887100,
    source_id: 887100,
    title: "الموقع الرسمي للشيخ محمد بن عبد الرحمن العريفي http://arefe.ws/fa/",
    kind: "source",
    type: "source",
    description: "الموقع الرسمي للشيخ محمد بن عبد الرحمن العريفي http://arefe.ws/fa/"
    }
  ],
  attachments: [
  {
    order: 1,
    size: "134.7 KB",
    extension_type: "PDF",
    description: "من روزه هستم",
    url: "//d1.islamhouse.com/data/fa/ih_articles/single/fa_man_rozah_hastam_modified.pdf"
    },
    {
    order: 2,
    size: "1.9 MB",
    extension_type: "DOC",
    description: "من روزه هستم",
    url: "//d1.islamhouse.com/data/fa/ih_articles/single/fa_man_rozah_hastam_modified.doc"
  }
  ],
  api_url: "http://api.islamhouse.com/v1/paV29H2gm56kvLPy/dynamic/ramadan/get-item/2769680/ar/json/"
  },
  {
    id: 2769630,
    source_id: 2769629,
    title: "تعجيل الفطر أفضل من تأخيره",
    description: "فتوى مترجمة إلى اللغة البوسنية عبارة عن سؤال أجاب عنه موقع الإسلام سؤال وجواب ونصه :"هل في تأخير الفطر بعد صلاة المغرب ثواب ؟".",
    full_description: null,
    add_date: 1439728585,
    type: "fatwa",
    image: null,
  prepared_by: [
  {
    id: 2769002,
    source_id: 2769001,
    title: "بقية سنانوفيتش",
    kind: "reviewer",
    type: "author",
    description: null
    },
    {
    id: 8712,
    source_id: 8712,
    title: "موقع الإسلام سؤال وجواب www.islamqa.info",
    kind: "source",
    type: "source",
    description: "موقع يعنى بالإجابة على تساؤلات المسلمين وغير المسلمين حول موضوعات الإسلام المتنوعة، ويساعد في حل المشاكل الإجتماعية الشخصية والعامة. يجيب على الأسئلة فضيلة الشيخ محمد صالح المنجد الداعية الإسلامي والمؤلف المعروف. قام بإعداد، ومراجعة، وتعديل، وتذييل فتاوى الموقع الشيخ محمد صالح المنجد مشرف الموقع. "
    },
    {
    id: 551830,
    source_id: 551829,
    title: "أروين سنانوفيتش",
    kind: "translator",
    type: "author",
    description: null
    }
  ],
  attachments: [
  {
    order: 1,
    size: "441.5 KB",
    extension_type: "PDF",
    description: "Pokuđenost odgađanja iftara",
    url: "//d1.islamhouse.com/data/bs/ih_fatawa/single2/bs_Pokudenost_odgadanja_iftara.pdf"
    },
    {
    order: 2,
    size: "4.2 MB",
    extension_type: "DOCX",
    description: "Pokuđenost odgađanja iftara",
    url: "//d1.islamhouse.com/data/bs/ih_fatawa/single2/bs_Pokudenost_odgadanja_iftara.docx"
    }
    ],
    api_url: "http://api.islamhouse.com/v1/paV29H2gm56kvLPy/dynamic/ramadan/get-item/2769629/ar/json/"
    },
  {
    id: 2769556,
    source_id: 2769555,
    title: "ما هي ليلة القدر ؟",
    description: "مقالة باللغة السواحيلية فيها بيان ليلة القدر وفيها بيان أهمية ليلة القدر وأن هذه ليلة خير من ألف شهر، وأجرها عظيم لمن قامها إيمانا واحتسابا.",
    full_description: null,
    add_date: 1439655625,
    type: "articles",
    image: null,
  prepared_by: [
    {
    id: 794831,
    source_id: 794831,
    title: "أبو بكر شعبان روكونكوا",
    kind: "reviewer",
    type: "author",
    description: null
    },
    {
    id: 8636,
    source_id: 8636,
    title: "المكتب التعاوني للدعوة وتوعية الجاليات بالربوة",
    kind: "source",
    type: "source",
    description: "مؤسسة خيرية دعوية قائمة على جهود المحتسبين وتبرعات المحسنين، وقد أسس بتوجيه من سماحة الشيخ العلامة عبد العزيز بن عبد الله بن باز مفتي عام المملكة العربية السعودية - رحمه الله تعالى -، وذلك في الثلاثاء الموافق الثامن والعشرين من الشهر الثامن لعام أربعة عشر وأربعمائة وألف للهجرة النبوية على صاحبها أفضل الصلاة وأتم التسليم، والمكتب يعمل تحت إشراف وزارة الشؤون الإسلامية والأوقاف والدعوة والإرشاد."
    }
    ],
  attachments: [
    {
    order: 1,
    size: "496.1 KB",
    extension_type: "PDF",
    description: "NI UPI USIKU WA LAYLATUL QADR",
    url: "//d1.islamhouse.com/data/sw/ih_articles/single/sw_NI_UPI_USIKU_WA_LAYLATUL_QADR.pdf"
    },
    {
    order: 2,
    size: "5.1 MB",
    extension_type: "DOCX",
    description: "NI UPI USIKU WA LAYLATUL QADR",
    url: "//d1.islamhouse.com/data/sw/ih_articles/single/sw_NI_UPI_USIKU_WA_LAYLATUL_QADR.docx"
    }
    ],
    api_url: "http://api.islamhouse.com/v1/paV29H2gm56kvLPy/dynamic/ramadan/get-item/2769555/ar/json/"
    }
  ]
}

في المثال السابق سوف تجد متغيرات هامة تساعدك في تنظيم عملية تعدد الصفحات حيث يتم توضيح رقم الصفحة الحالية وعدد الصفحات للنتيجة وكذلك اجمالي عدد العناصر

أمثلة عامة

جلب الصوتيات فقط للمواد بلغة واجهة عربي ولغة مصدر عربي

http://api.islamhouse.com/v1/XXXXXXXX/dynamic/ramadan/get-content-by-type/audios/ar/ar/1/50/json  

جلب الصوتيات فقط للمواد بلغة واجهة عربي ولغة مصدر جميع اللغات

http://api.islamhouse.com/v1/XXXXXXXX/dynamic/ramadan/get-content-by-type/audios/ar/showall/1/50/json  

جلب الكتب فقط للمواد بلغة واجهة عربي ولغة مصدر جميع اللغات

http://api.islamhouse.com/v1/XXXXXXXX/dynamic/ramadan/get-content-by-type/books/ar/showall/1/50/json  

جلب الكتب فقط للمواد بلغة واجهة عربي ولغة مصدر روسي

http://api.islamhouse.com/v1/XXXXXXXX/dynamic/ramadan/get-content-by-type/books/ar/showall/1/50/json