PANORAMA API, seçilen çözüm vaka çalışmalarını web sitenizde görüntülemenize olanak tanır. Çözüm açıklamasının yalnızca belirli bölümleri çağrılabilir/erişilebilir, bunlar ihtiyacınız olan çözüm verilerini talep etmek için çeşitli filtreler ve sıralama seçenekleri içerir. Bu dokümantasyon PANORAMA API'yi kullanmanıza ve doğru ayarları bulmanıza yardımcı olur.
Kimlik Doğrulama
API'yi kullanmak için, PANORAMA API erişim belirtecinizi API isteğine ekleyin:
https://panorama.solutions/en/api/v1/solutions?api_key=1234
Temel kullanım ve çözüm dili
PANORAMA API'sinin URL'si şöyledir:
https://panorama.solutions/{language_prefix}/api/v1/solutionsDil öneki PANORAMA'da kullanılan üç dilden birine ayarlanabilir: en = İngilizce, fr = Fransızca ve es = İspanyolca. Dil öneki, çözümlerin hangi dilde listeleneceğini belirler: "en" olarak ayarlamak, İngilizce bir çeviri olduğu sürece çözümleri İngilizce çevirileriyle listeleyecektir - aksi takdirde çözüm, Fransızca veya İspanyolca olabilen orijinal dilinde listelenecektir.
https://panorama.solutions/en/api/v1/solutions
API isteğinize bir filtre ekleyerek bu davranışı değiştirebilir ve yalnızca belirli bir dilde yayınlanan çözümleri almaya zorlayabilirsiniz. Örneğin: İspanyolcaya çevrilmiş çözümleri almak istiyorsanız aşağıdaki API isteğini kullanın:
https://panorama.solutions/es/api/v1/solutions?language[]=es
Lütfen aşağıdakileri dikkate alın:
- Filtreler, filtre adı ("dil"), ardından köşeli parantez [], eşittir işareti ve değer kullanılarak eklenir. Bununla ilgili daha fazla bilgiyi aşağıda bulabilirsiniz.
- "Dil" filtresini eklerseniz, ilgili çevrilmiş metinleri otomatik olarak almazsınız. Tercih ettiğiniz dile çevrilmiş çözümleri almak için dil önekini değiştirmeyi unutmayın.
- API isteğine "&" ile ekleyerek birden fazla istek parametresi ekleyebilirsiniz.
https://panorama.solutions/es/api/v1/solutions?language[]=es&another_filter[]=123
Sıralama
API'mizden aldığınız çözümlerin sıralamasını değiştirebilirsiniz. Sıralama için iki parametre mevcuttur: "sort_by" ve "sort_order" (isteğe bağlıdır). "sort_order" için artan sıra için "ASC" ve azalan sıra için "DESC" değerlerini ayarlayabilirsiniz. Lütfen "sort_order" parametresi için "ASC" ve "DESC" değerlerinin büyük harflerle yazılması gerektiğini unutmayın. "sort_order" parametresi ayarlanmadığında, "sorty_by" için her seçeneğin varsayılan bir değeri vardır. "sort_by" parametresi için seçenekler aşağıdaki gibidir:
Çözümleri alfabetik sıraya göre artan şekilde almak istediğinizde, isteğinize aşağıdakileri eklersiniz:
https://panorama.solutions/en/api/v1/solutions?sort_by=title_field&sort_order=ASC
changed: Çözümlerin en son değiştirildiği tarihe göre sıralayarak en yenisini ilk (veya son) olarak alır. Varsayılan sıra: DESCtitle_field: Çözümün başlığına göre alfabetik sıralama. Varsayılan sıra: ASCsearch_api_relevance: Bir arama terimiyle ilgili çözümlerin alaka düzeyi - bu sıralama seçeneği, daha sonra açıklanacak olan aramamıza karşı bir sorgu çalıştırdığınızda kullanışlıdır. Varsayılan sıra: DESC (önce yüksek alaka düzeyi)
Filtreler
Sadece ilginizi çeken çözümleri filtrelemek için birçok filtre kullanabilirsiniz.
Her filtre birden fazla kez kullanılabileceğinden, filtrelerin API isteğinize köşeli parantezlerle eklenmesi gerektiğine dikkat etmek önemlidir. Örneğin, "Ekosistem" filtresinden "Agro-ekosistem" kategorisine (id'si 370 olan) bağlı çözümleri almak için API isteğinize aşağıdakileri eklemeniz gerekecektir:
https://panorama.solutions/en/api/v1/solutions?ecosystem[]=370
Bu, "Ekosistem" filtresi içinde farklı kategorilere bağlı çözümlerin toplanmasını mümkün kılar. "Agro-ekosistem" ve "Çöl ekosistemleri" (33 id'ye sahip) ile ilgili çözümlerle ilgileniyorsanız, aşağıdaki API isteğini kullanabilirsiniz:
https://panorama.solutions/en/api/v1/solutions?ecosystem[]=370&ecosystem[]=33
Kullanmak istediğiniz tüm filtreleri almak için PANORAMA Explorer sayfasını kullanabilirsiniz - tarayıcı adres çubuğunda filtreleme için explorer'ı kullandığınızda ihtiyacınız olan tüm parametreleri içeren bir URL bulacaksınız. Bu URL parametrelerini PANORAMA API istek yoluna eklemek için kullanabilirsiniz. Bu API'de daha fazla filtreye sahip olduğunuzu unutmayın.
Arama terimleri/anahtar kelimeler ile arama
PANORAMA Explorer sayfasına benzer şekilde, bir veya daha fazla anahtar kelime/arama terimi ile ilgili çözümler bulmak için bir arama yapabilirsiniz. Bunun için "keyword" parametresini kullanın:
https://panorama.solutions/en/api/v1/solutions?keyword=marine
Aramayı daraltmak için URL kodlu boşluklarla ayrılmış anahtar kelimeler ekleyerek birden fazla anahtar kelime ekleyebilirsiniz, böylece "deniz balıkçılığı" için yapılan bir arama aşağıdaki gibi görünecektir:
https://panorama.solutions/en/api/v1/solutions?keyword=marine%20fisheries
Arama terimleri içeren API istekleri için, aramanızla daha alakalı olan çözümleri ilk önce almak için her zaman "search_api_relevance" değerine sahip "sort_by" sıralama parametresini eklemelisiniz:
https://panorama.solutions/en/api/v1/solutions?keyword=marine%20fisheries&sort_by=search_api_relevance
Çağrı
Her yanıtta en fazla 20 çözüm alacaksınız. API, isteğinize "page" parametresini ekleyerek sonraki 20 çözümü alabilmeniz için bir sayfalama sunar:
https://panorama.solutions/en/api/v1/solutions?page=2
Yanıt, 2. sayfada çözüm olup olmadığına dair herhangi bir bilgi içermez, bu nedenle bir sonraki sayfayı ararken bunu kendiniz kontrol etmeniz gerekir.
Kimlik veya WDPA ile Tek Bir Çözüm Talep Etme
nid=NODE_ID ve &wdpa=NODE_ID parametrelerini kullanabilirsiniz.
&nid
Tek bir Çözüm talep etmek için &nid Filtresini kullanabilirsiniz
Kimliği API talep ederek (çözüm nesnesinin bir parçasıdır) veya bir Çözümün HTML kaynak koduna bakarak bulabilirsiniz (bkz. body etiketi)
https://panorama.solutions/es/api/v1/solutions?api_key=123456&nid=115
&wdpa
Korunan Alanlar Çözümleri, Korunan Gezegen WDPA Kimliğini içerir.
Yanıt, eşleşen ID'ye sahip tüm Çözümleri içerecektir
https://panorama.solutions/es/api/v1/solutions?api_key=123456&wdpa=115
Ülke ISO kodlarına göre Çözüm Talep Etme
Ülke iso'suna göre filtrelenmiş Çözümler istemek için &country_iso_2 parametresini kullanın
https://panorama.solutions/es/api/v1/solutions?api_key=123456&country_iso_2=DE
Portal Başlığına Göre Çözüm Talep Etme
Atandıkları Portala göre filtrelenmiş Çözümleri talep etmek için &portal_title parametresini kullanın. Portal Başlığı, bir portal / tematik topluluk sayfasına ait URL'nin bir parçası olarak bulunabilir.
Örneğin https://panorama.solutions/en/portal/protected-areas
burada protected-areas bir API filtresi olarak kullanılabilecek ilgili portal başlığıdır.
https://panorama.solutions/es/api/v1/solutions?api_key=123456&portal_title=protected-areas
Portal Kimliğine Göre Çözüm Talep Etme
Atandıkları Portal Kimliğine göre filtrelenen Çözümleri talep etmek için &portal_id parametresini kullanın. Portal Kimliği, bir Portal sayfası düzenlenirken URL'de bulunabilir.
https://panorama.solutions/es/api/v1/solutions?api_key=123456&portal_id=4673