ما هو دليل واجهة برمجة التطبيقات (API)؟
يعد دليل واجهة برمجة التطبيقات (API) مرجعًا شاملًا يهدف إلى مساعدة المطورين في فهم واجهة برمجة التطبيقات لمنصة البيانات الصحية واستخدامها بكفاءة. يوفر الدليل معلومات مفصّلة عن كيفية المصادقة، ونقاط النهاية المتاحة (Endpoints)، بالإضافة إلى تنسيقات الطلبات والاستجابات وغيرها لضمان دمج واجهة البرمجة بسهولة في تطبيقاتك وأتمتة العمليات والوصول إلى البيانات بسلاسة.
يتضمن الدليل شرحًا وافيًا حول كيفية استخدام رابط الطلب بفعالية، مدعومًا بأمثلة توضيحية بلغات برمجة متعددة. كما يحتوي على جداول توضح المعطيات الرئيسة والرؤوس المستخدمة في الطلبات، بالإضافة إلى تفسير الاستجابات المحتملة لمساعدتك في فهم آلية عمل واجهة البرمجة والتعامل معها بفعالية.
- يٌنصح بمراجعة هذا القسم بانتظام لمتابعة أي تحديثات قد تؤثر على استخدامك.
- الحد الأقصى للطلبات المسموح بها لكل مستخدم (10), لذلك تأكد من عدم تجاوز هذا الحد لتجنب انقطاع الخدمة
- لا يتطلب الوصول إلى واجهة برمجة تطبيقات منصة البيانات الصحية استخدام مفتاح API ، حيث يمكن التفاعل مع نقاط النهاية مباشرة دون الحاجة إلى المصادقة (authentication).
جلب معلومات مجموعة البياناتV1.0GEt
- تعريف V1.0: هي عبارة عن دالة تستخدم لجلب البيانات من الموقع عندما يرسل طلب.
- تعريف GET: تعريف GET: هي عبارة عن دالة تستخدم لجلب البيانات من الموقع عندما يرسل طلب.
- رابط الطلب: هو الرابط المباشر الذي يمكنك استخدامه للوصول إلى البيانات عبر واجهة API لمجموعة البيانات
https://hdp.moh.gov.sa/api/v1/[resourceId]
أمثلة الاستخدام
أمثلة توضح كيفية استخدام API مع أدوات البرمجة المختلفة. اختر من التبيوبات لغة البرمجة التي تتناسب مع إحتياجك
- Python
- JavaScript
- PHP
- CURL
import requests url = "https://open-data-portal.devclan.io/api/v1/[resourceId]" payload = {} headers = { 'culture': '<String>', 'Accept': 'text/plain', 'Cookie': '__cf_bm=GLI75xYpw1tiPJpUzNp2xyqyehUk33aASaEceQE4TFQ-1726516105-1.0.1.1-2WlNbdIBifT5XMEt.UGhpx.G4plkSgcn.8YmZ9UobwlENN3.Ggw7PQDDWT3KdB4OX7o7FH21XMpu8swrn_jOeQ; NEXT_LOCALE=ar' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
الاستجابة المتوقعة
- 200
- 404
- 400
- 500
{ "transactionId": "String", "datasetId": "String", "resources": [ { "id": "String", "name": "String", "descriptionEn": "String", "descriptionAr": "String", "format": "String", "columns": [ { "name": "String", "type": "String", "description": "String" } ], "downloadUrl": "String", "createdAt": "String", "updatedAt": "String" } ] }