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

لاستخدام واجهة برمجة التطبيقات، أضف رمز الوصول إلى واجهة برمجة التطبيقات PANORAMA API إلى طلب واجهة برمجة التطبيقات:

https://panorama.solutions/en/api/v1/solutions?api_key=1234

عنوان URL لواجهة PANORAMA API هو:

https://panorama.solutions/{language_prefix}/API/v1/solutions

يمكن ضبط بادئة اللغة على واحدة من اللغات الثلاث المستخدمة في بانوراما: en = الإنجليزية، fr = الفرنسية، es = الإسبانية. تحدد بادئة اللغة اللغة اللغة التي يتم إدراج الحلول بها: سيؤدي ضبطها على "en" إلى إدراج الحلول مع ترجمتها الإنجليزية طالما كانت هناك ترجمة إنجليزية - وإلا سيتم إدراج الحل بلغته الأصلية التي يمكن أن تكون الفرنسية أو الإسبانية.

https://panorama.solutions/en/api/v1/solutions

يمكنك تعديل هذا السلوك وفرض تلقي الحلول المنشورة بلغة معينة فقط عن طريق إضافة عامل تصفية إلى طلب واجهة برمجة التطبيقات. على سبيل المثال: إذا كنت تريد تلقي الحلول المترجمة إلى الإسبانية، استخدم طلب واجهة برمجة التطبيقات التالي

https://panorama.solutions/es/api/v1/solutions?language[]=es

يرجى مراعاة ما يلي:

• تتم إضافة الفلاتر باستخدام اسم المرشح ("اللغة")، متبوعًا بأقواس مربعة []، وعلامة يساوي والقيمة. المزيد عن ذلك أدناه.
• إذا أضفت عامل التصفية "لغة" فلن تتلقى تلقائيًا النصوص المترجمة المقابلة. تذكر تغيير بادئة اللغة لتلقي الحلول المترجمة إلى اللغة التي تفضلها.
• يمكنك إضافة معلمات طلب متعددة عن طريق إضافتها بحرف "&" إلى طلب واجهة برمجة التطبيقات.

https://panorama.solutions/es/api/v1/solutions?language[]=es&  another_filter[]=123

يمكنك تغيير فرز الحلول التي تتلقاها من واجهة برمجة التطبيقات الخاصة بنا. بالنسبة للفرز، هناك معلمتان متاحتان: "sort_by" و "sort_order" (وهو اختياري). بالنسبة إلى "sort_order" يمكنك تعيين "ASC" للترتيب التصاعدي و"DESC" للترتيب التنازلي. يُرجى الأخذ في الاعتبار أن القيمتين "ASC" و "DESC" لمعلمة "sort_order" يجب أن تُكتب بأحرف كبيرة. عندما لا يتم تعيين معلمة "sort_order" يكون لكل خيار لـ "sorty_by" قيمة افتراضية. خيارات معلمة "sort_by" هي التالية:

https://panorama.solutions/en/api/v1/solutions?sort_by=title_field&sort_order=ASC

• تم التغيير: الفرز حسب تاريخ تغيير الحلول في آخر مرة للحصول على الأحدث أولاً (أو الأخير). الترتيب الافتراضي: DESC
• العنوان_الحقل: الترتيب الأبجدي حسب عنوان الحل. الترتيب الافتراضي: ASC
• search_api_relevance: مدى ملاءمة الحلول المتعلقة بمصطلح البحث - خيار الفرز هذا مفيد فقط إذا قمت بتشغيل استعلام مقابل بحثنا الذي سيتم شرحه لاحقًا. الترتيب الافتراضي: DESC (الصلة العالية أولاً)

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

من المهم ملاحظة أنه يجب إضافة الفلاتر بأقواس مربعة إلى طلب واجهة برمجة التطبيقات الخاصة بك حيث يمكن استخدام كل فلتر عدة مرات. على سبيل المثال، للحصول على الحلول المتصلة بفئة "النظام الإيكولوجي الزراعي" (وهو المعرف 370) من مرشح "النظام الإيكولوجي"، ستحتاج إلى إضافة ما يلي إلى طلب واجهة برمجة التطبيقات

https://panorama.solutions/en/api/v1/solutions?ecosystem[]= 370

وهذا يجعل من الممكن جمع الحلول المتصلة بفئات مختلفة ضمن مرشح "النظام الإيكولوجي". إذا كنت مهتمًا بالحلول المتعلقة بـ "النظام الإيكولوجي الزراعي" و"النظم الإيكولوجية الصحراوية" (التي تحمل المعرف 33) يمكنك استخدام طلب واجهة برمجة التطبيقات التالي

https://panorama.solutions/en/api/v1/solutions?ecosystem[]= 370&النظام البيئي[]= 33

للحصول على جميع المرشحات التي تريد استخدامها، يمكنك استخدام صفحة مستكشف بانوراما - عند استخدام المستكشف للتصفية في شريط عنوان المتصفح ستجد عنوان URL مع جميع المعلمات التي تحتاجها. يمكنك استخدام معلمات URL هذه لإضافتها إلى مسار طلب PANORAMA API. ضع في اعتبارك أن لديك المزيد من المرشحات المتاحة في واجهة برمجة التطبيقات هذه.

على غرار صفحة صفحة PANORAMA Explorer، يمكنك إجراء بحث للعثور على حلول تتعلق بكلمة رئيسية/مصطلح بحث واحد أو أكثر. استخدم معلمة "الكلمة المفتاحية" لهذا الغرض:

https://panorama.solutions/en/api/v1/solutions?keyword=marine

يمكنك إضافة عدة كلمات مفتاحية لتضييق نطاق البحث، وذلك بإضافة كلمات مفتاحية مفصولة بمسافات مشفرة بعناوين URL بحيث يبدو البحث عن "مصايد الأسماك البحرية" كما يلي

https://panorama.solutions/en/api/v1/solutions?keyword=marine%20fisheries

بالنسبة لطلبات واجهة برمجة التطبيقات التي تحتوي على مصطلحات بحث، يجب عليك دائمًا إضافة معلمة الفرز "sort_by" بقيمة "search_api_relevance" للحصول على تلك الحلول أولاً التي تكون أكثر صلة ببحثك:

https://panorama.solutions/en/api/v1/solutions?keyword=marine%20fisheries&sort_by=search_api_relevance

ستتلقى في كل استجابة 20 حلاً كحد أقصى. توفر واجهة برمجة التطبيقات ترحيل الصفحات بحيث يمكنك الحصول على الحلول العشرين التالية عن طريق إضافة معلمة "الصفحة" إلى طلبك:

https://panorama.solutions/en/api/v1/solutions?page=2

لا تتضمن الاستجابة أي معلومات إذا كانت هناك حلول في الصفحة 2، لذا عليك التحقق من ذلك بنفسك عند طلب الصفحة التالية.

يمكنك استخدام المعاملتين &nid=NODE_ID و&wdpa=NODE_ID

&nid
لطلب حل واحد يمكنك استخدام عامل التصفية &nid
يمكنك العثور على المعرف من خلال طلب واجهة برمجة التطبيقات (وهو جزء من كائن الحل) أو من خلال النظر إلى رمز مصدر HTML الخاص بالحل (انظر علامة النص الأساسي)

https://panorama.solutions/es/api/v1/solutions?api_key=123456&nid=115

&wdpa
حلول المناطق المحمية تحتوي حلول المناطق المحمية على معرّف WDPA للكوكب المحمي.
ستتضمن الاستجابة جميع الحلول التي تحتوي على المعرف المطابق

https://panorama.solutions/es/api/v1/solutions?api_key=123456&wdpa=115

استخدم المعلمة &country_iso_2 لطلب الحلول التي تمت تصفيتها حسب البلد ISO

https://panorama.solutions/es/api/v1/solutions?api_key=123456&country_iso_2=DE

استخدم المعلمة &portal_title_title لطلب الحلول التي تمت تصفيتها حسب البوابة التي تم تعيينها لها. يمكن العثور على عنوان البوابة كجزء من عنوان URL الذي ينتمي إلى صفحة البوابة/المجتمع المواضيعي.

على سبيل المثال https://panorama.solutions/en/portal/protected-areas
حيث تكون المناطق المحمية هي عنوان البوابة المقابل الذي يمكن استخدامه كمرشح لواجهة برمجة التطبيقات.

https://panorama.solutions/es/api/v1/solutions?api_key=123456&portal_title=protected-areas

استخدم المعلمة &portal_id لطلب الحلول التي تمت تصفيتها حسب معرّف البوابة المعينة لها. يمكن العثور على معرف البوابة في عنوان URL عند تحرير صفحة البوابة.

https://panorama.solutions/es/api/v1/solutions?api_key=123456&portal_id=4673