أهلاً بكم في الأمم المتحدة
شريط أدوات الدخول إلى البوابة
زيادة التبايُن
تكبير حجم الخط
تصغير حجم الخط
إعادة ضبط نمط الصفحة

وثائق واجهة برمجة التطبيقات (API)

لمحة عن واجهة برمجة تطبيقات المؤشرات

توفّر واجهة برمجة تطبيقات المؤشرات التابعة للجنة الأمم المتحدة المعنية بالموارد المائية إمكانية الوصول إلى بياناتٍ متراكمة لمصادر متنوعة. يمكن الاطلاع على معظم هذه المؤشرات على الإنترنت. وتوفر واجهة برمجة التطبيقات إمكانية الوصول إلى هذه البيانات نفسها. فكثير من سلاسل البيانات تعود إلى أكثر من 50 سنة، ويُمكن استخدامها لإنشاء تطبيقاتٍ مثيرة للاهتمام.

توفر واجهة برمجة تطبيقات المؤشرات إمكانية الوصول إلى قواعد البيانات، بما في ذلك:

  • منظمة الصحة العالمية
  • برنامج الأمم المتحدة الإنمائي
  • اليونيسف
  • منظمة الأغذية والزراعة للأمم المتحدة (الفاو)
  • ومؤسسات أخرى كثيرة

لمحة عن كيفية استخدام واجهة برمجة تطبيقات المؤشرات

 على سبيل المثال: https://sdg6data.org/api/indicator/6.1.1?_format=json

إلى جانب إمكانية الاتصال بواجهة (API) باستخدام تطبيق أو برنامج خاص، يمكنك أيضاً أن تضع أي نموذج من نقاط النهاية لعنوان (URL) المذكور في التوثيق على الواجهة، أو في اتصالاتك الخاصة، في متصفّح الويب ورؤية النتائج. إذا اخترت تلقّي النتيجة بصيغة (JSON)، يُمكنك حينئذٍ استخدام القابس المُخصص لهذه الصيغة JSON View على متصفّح فايرفوكس (Firefox) لتتمكَّن من رؤيتها مباشرةً وبسهولة في المتصفح.

وتتوفر أيضاً تطبيقات ومكتبات الأطراف الثالثة التي قد تُسهّل استخدام واجهة برمجة التطبيقات (API) حسب مُستهدفاتك. 

يُرجى مراجعة هيكل الاتصال الأساسي أدناه:

يُظهر توثيق واجهة برمجة التطبيقات (API) أدناه كيف يمكن الوصول إلى استخدام هذه البيانات من داخل التطبيق على جهازك.

https://sdg6data.org/api/indicator/{indicator_code}?_format=xml

بارامترات الطلب:

{indicator_code} - أي رمز من رموز مؤشرات الهدف 6. رمز المؤشر هو جزء من عنوان (URL) لواجهة برمجة التطبيقات (API)، وهو إلزامي للمرور في اتصالٍ مع الواجهة.

https://sdg6data.org/api/indicator/6.1.1?_format=xml

عنوان (URL) المذكور أعلاه سيأتي ببيانات المؤشر 6-1-1 عن العام بأكمله والبلد بأكمله

_format : صيغة ملف الإخراج. تدعم واجهة (API) صيغتَين هما: (xml) و(json). هذا البارامتر إلزامي وفق معايير خدمة Drupal 8 RESTful للويب.

https://sdg6data.org/api/indicator/6.1.1?_format=xml

https://sdg6data.org/api/indicator/6.1.1?_format=json

per_page: عدد النتائج لكل صفحة من أجل ترقيم مجموعة النتيجة. الإعداد الافتراضي هو 50

https://sdg6data.org/api/indicator/6.1.1?_format=xml&per_page=20

page – أحد بارامترات المرفق يتيح لك تصفُّح مجموعة كبيرة من النتائج. يُشير إلى رقم الصفحة المطلوبة من مجموعة سجلاتٍ كبيرة.

https://sdg6data.org/api/indicator/6.1.1?_format=xml&page=2

date – الفترة الزمنية المُحدَّدة بالسنة أو الشهر أو الفصل الذي تقع مجموعة النتائج في نطاقها. يُشار إلى الفترة الزمنية باستخدام فاصل النقطتَين.

https://sdg6data.org/api/indicator/6.1.1?_format=xml&date=2000:2001

عرض جميع بيانات المؤشر باستخدام أداة الاستعلام عنه مع بارامترات خاصة ببلدانٍ متعددة.

https://sdg6data.org/api/indicator/6.1.1?_format=json&country=CAN,ALB

عرض جميع بيانات المؤشر باستخدام أداة الاستعلام عنه.

https://sdg6data.org/api/indicator/all?_format=json

أدوات الاستعلام عن واجهة برمجة التطبيقات (API) الخاصة بالمؤشرات

تُمثّل المؤشرات بيانات متعلقة مثلاً بالمناطق الوطنية أو الحَضَرية أو الريفية، وتوفُّر المياه واستخدامها، وإدارة الموارد المائية، وعدد الوفيات، وعدد المفقودين، وأشياء كثيرة أخرى. أدوات الاستعلام عن المؤشر تأتي بالمعلومات التالية في الإجابة:

  • الهدف
  • الغاية
  • المؤشر
  • SeriesCode
  • SeriesDescription
  • GeoAreaType
  • GeoAreaName
  • GeoAreaCode
  • TimePeriod
  • Value
  • Time_Detail
  • المصدر
  • FootNote
  • الطبيعة
  • الوحدات
  • العمر
  • الحدود
  • التكرار
  • Level_Status
  • الموقع
  • Reporting_Type
  • الجنس

نموذج الطلب: الاستعلام عن المؤشر

https://sdg6data.org/api/indicator/all?_format=json

لطلب المؤشر 6-1-1، يُرجى استخدام الرمز الخاص بالمؤشر،

6-1-1

عيّنة نموذج الإجابة: الاستعلام عن المؤشر

 <response> <item key="0"> <page>0</page> <pages>11593</pages> <per_page>50</per_page> <total>579635</total> </item> <item key="0"> <item key="0"> <Goal/> <Target/> <Indicator>6-1-1 </Indicator> <SeriesCode/> <SeriesDescription>مياه الشرب، الخدمة على الأقل أساسية</SeriesDescription> <GeoAreaType>البلد</GeoAreaType> <GeoAreaName>ABW</GeoAreaName> <GeoAreaCode>533</GeoAreaCode> <TimePeriod>2000</TimePeriod> <Value>94.488806355508</Value> <Time_Detail/> <Source>منظمة الصحة العالمية، اليونيسف</Source> <FootNote/> <Nature/> <Units/> <Age/> <Bounds/> <Frequency/> <Level_Status/> <Location>National</Location> <Reporting_Type/> <Sex/> <SDG_6_Data_Portal_level><![CDATA]6-1-1 نسبة السكان الذين يستفيدون من خدمات مياه الشرب التي تُدار بطريقةٍ مأمونة (٪) > الخدمات على الأقل أساسية > وطنية
 [{   "page":0, "pages":11593, "per_page":50, "total":579635   ٪ [{ "Goal":null,   "Target":null,   "Indicator":"6.1.1",   "SeriesCode":null,   <SeriesDescription>مياه الشرب، الخدمة على الأقل أساسية</SeriesDescription>   "GeoAreaType":"البلد",   "GeoAreaName":"ABW",   "GeoAreaCode":"533",   "TimePeriod":"2000",   "Value":"94.488806355508",   "Time_Detail":null,   <Source>"منظمة الصحة العالمية، اليونيسف"،   "FootNote":null,   "Nature":null,   "Units":null,   "Age":null,   "Bounds":null,   "Frequency":null,   "Level_Status":null,   "Location":"National",   "Reporting_Type":null,   "Sex":null,   "SDG_6_Data_Portal_level":"6-1-1 نسبة السكان الذين يستفيدون من خدمات مياه الشرب التي تُدار بطريقةٍ مأمونة (٪) \u003E خدمات على الأقل أساسية \u003E على الصعيد الوطني"   }]  ]

عيّنة نموذج الإجابة: الاستعلام عن المؤشر مع فلتر يُحدّد البلد:

 [{"page":0, "pages":2804, "per_page":50, "total":140199}, [{"Goal":null, "Target":null, "Indicator":"6.1.1", "SeriesCode":null, <SeriesDescription>مياه الشرب، الخدمة على الأقل أساسية</SeriesDescription> "GeoAreaType":"البلد", "GeoAreaName":"ABW", "GeoAreaCode":"533", "TimePeriod":"2000", "Value":"94.488806355508", "Time_Detail":null, "Source":"منظمة الصحة العالمية، اليونيسف", "FootNote":null, "Nature":null, "Units":null, "Age":null, "Bounds":null, "Frequency":null, "Level_Status":null, "Location":"National", "Reporting_Type":null, "Sex":null, "SDG_6_Data_Portal_level":"6-1-1 نسبة السكان الذين يستفيدون من خدمات مياه الشرب التي تُدار بطريقةٍ مأمونة (٪) \u003E خدمات على الأقل أساسية \u003E على الصعيد الوطني"}]

يمكنك تنزيل قائمة البلد مع رموز (ISO3) هنا

منفذ إلى واجهة برمجة التطبيقات (API) / التوثيق

لم تَعُد مفاتيح واجهة برمجة التطبيقات (API) ووسائل التوثيق الأخرى ضرورية للوصول إلى الواجهة.