توثيق API

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

البدء

توفر واجهة برمجة تطبيقات الميزانية وصولاً برنامجيًا إلى بيانات الميزانية. تُرجع جميع نقاط النهاية استجابات بتنسيق JSON وتدعم معلمات الاستعلام المختلفة للتصفية وترقيم الصفحات.

صيغة الاستجابة

يتم إرجاع جميع الردود بتنسيق JSON مع رموز حالة HTTP المناسبة.

الوصول

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

ملاحظة
قد يتم تطبيق حد لمنع إساءة الاستخدام. يرجى الاتصال بنا إذا كنت بحاجة إلى حدود أعلى.

إجماليات الميزانية

استرجاع أرقام الميزانية الإجمالية بما في ذلك النفقات والموارد لجميع السنوات، وتغطية الميزانية الرئيسية والميزانيات التكميلية.

GET /budget/api/totals/

Parameters

Parameter النوع الوصف
year integer تصفية حسب السنة المحددة
include_complementary boolean تضمين الميزانيات التكميلية

الاستجابة

تم تنسيق نص الاستجابة JSON بالهيكل التالي:

الحقل النوع الوصف
year integer سنة الميزانية
total_expenses number إجمالي النفقات
total_resources number إجمالي الموارد
balance number رصيد الميزانية

فئات الميزانية

استرجاع بيانات الميزانية المنظمة حسب الفئات، بما في ذلك النفقات والموارد.

GET /budget/api/budget-categories/

Parameters

Parameter النوع الوصف
year integer تصفية حسب سنة الميزانية
type string تصفية حسب النوع: 'نفقة' أو 'مورد'

الاستجابة

تم تنسيق نص الاستجابة JSON بالهيكل التالي:

الحقل النوع الوصف
category string اسم الفئة
expenses number إجمالي النفقات في الفئة
resources number إجمالي الموارد في الفئة

النفقات

استرجاع نفقات الميزانية مع هيكل هرمي اختياري. تتيح لك هذه النقطة استكشاف بيانات النفقات على مستويات مختلفة من التفاصيل.

GET /budget/api/expenses/

Parameters

Parameter النوع الوصف
year integer تصفية النفقات حسب سنة الميزانية
hierarchy boolean إرجاع الهيكل الهرمي إذا كان صحيحًا
organization integer تصفية حسب معرف المنظمة
limit integer عدد النتائج المطلوب إرجاعها لكل صفحة
offset integer الفهرس الأولي الذي يتم منه إرجاع النتائج

الاستجابة

تم تنسيق نص الاستجابة JSON بالهيكل التالي:

الحقل النوع الوصف
id integer معرف سجل النفقة
year integer سنة الميزانية
amount number مبلغ النفقة
category string فئة النفقة
organization object تفاصيل المنظمة المرتبطة

الموارد

استرجاع موارد الميزانية مع هيكل هرمي اختياري. تمثل الموارد الإيرادات ومصادر التمويل.

GET /budget/api/resources/

Parameters

Parameter النوع الوصف
year integer تصفية الموارد حسب سنة الميزانية
hierarchy boolean إرجاع الهيكل الهرمي إذا كان صحيحًا
limit integer عدد النتائج المطلوب إرجاعها لكل صفحة
offset integer الفهرس الأولي الذي يتم منه إرجاع النتائج

الاستجابة

تم تنسيق نص الاستجابة JSON بالهيكل التالي:

الحقل النوع الوصف
id integer معرف سجل المورد
year integer سنة الميزانية
amount number مبلغ المورد
source string مصدر أو نوع المورد

قائمة المنظمات

استرجاع قائمة المنظمات مع تفاصيلها بما في ذلك الاسم والرمز ومعلومات الميزانية المرتبطة.

GET /budget/api/organization/

Parameters

Parameter النوع الوصف
year integer تصفية المنظمات حسب سنة الميزانية
limit integer عدد النتائج المطلوب إرجاعها لكل صفحة
offset integer الفهرس الأولي الذي يتم منه إرجاع النتائج

الاستجابة

تم تنسيق نص الاستجابة JSON بالهيكل التالي:

الحقل النوع الوصف
id integer معرف فريد للمنظمة
name string اسم المنظمة
code string رمز المنظمة

إحصائيات المنظمات

استرجاع المعلومات الإحصائية والبيانات المجمعة للمنظمات.

GET /budget/api/organization/stats/

Parameters

Parameter النوع الوصف
year integer تصفية الإحصائيات حسب سنة الميزانية
organization_id integer تصفية حسب معرف منظمة محدد

الاستجابة

تم تنسيق نص الاستجابة JSON بالهيكل التالي:

الحقل النوع الوصف
organization_id integer معرف المنظمة
total_expenses number إجمالي مبلغ النفقات
total_resources number إجمالي مبلغ الموارد

الديون

استرجاع معلومات الديون حسب المصدر والسنة.

GET /budget/api/debt/

Parameters

Parameter النوع الوصف
year integer تصفية بيانات الديون حسب السنة
parent string تصفية حسب مصدر الدين الأصلي (استخدم 'null' لمصادر المستوى الأعلى)

الاستجابة

تم تنسيق نص الاستجابة JSON بالهيكل التالي:

الحقل النوع الوصف
year integer سنة سجل الدين
debt_origin object معلومات مصدر الدين (المعرف، الأصل، الاسم)
value number قيمة الدين بالمليون دينار تونسي

الدين المستحق

استرجاع معلومات الدين المستحق - المبلغ الإجمالي من المال الذي لا يزال مستحقًا ولم يتم سداده بعد، بما في ذلك المبلغ الأصلي المتبقي والفوائد المتراكمة والرسوم المرتبطة.

GET /budget/api/outstanding-debt/

Parameters

Parameter النوع الوصف
year integer or 'last' تصفية حسب السنة أو استخدم 'last' لأحدث سنة

الاستجابة

تم تنسيق نص الاستجابة JSON بالهيكل التالي:

الحقل النوع الوصف
year integer سنة سجل الدين المستحق
outstanding_debt number المبلغ الإجمالي للدين المستحق بالمليون دينار تونسي (المبلغ الأصلي المتبقي والفوائد والرسوم)
gdp number الناتج المحلي الإجمالي بالمليون دينار تونسي
value number الدين المستحق كنسبة مئوية من الناتج المحلي الإجمالي

العجز

استرجاع معلومات العجز في الميزانية بما في ذلك القيم المطلقة والنسبة المئوية بالنسبة للناتج المحلي الإجمالي.

GET /budget/api/deficit/

الاستجابة

تم تنسيق نص الاستجابة JSON بالهيكل التالي:

الحقل النوع الوصف
year integer سنة الميزانية
value number القيمة المطلقة للعجز بالمليون دينار تونسي
percent number العجز كنسبة مئوية من الناتج المحلي الإجمالي
gdp number الناتج المحلي الإجمالي بالمليون دينار تونسي