Dokumentasi API

API PANORAMA memungkinkan Anda untuk menampilkan studi kasus solusi yang dipilih di situs web Anda. Hanya bagian tertentu dari deskripsi solusi yang dapat dipanggil/diakses, termasuk beberapa filter dan opsi penyortiran untuk meminta data solusi yang Anda butuhkan. Dokumentasi ini membantu Anda untuk menggunakan PANORAMA API dan menemukan pengaturan yang tepat.

Otentikasi

Untuk menggunakan API, tambahkan token akses API PANORAMA Anda ke permintaan API:

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

Penggunaan dasar dan bahasa solusi

URL dari PANORAMA API adalah:

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

Awalan bahasa dapat diatur ke salah satu dari tiga bahasa yang digunakan di PANORAMA: en = bahasa Inggris, fr = bahasa Prancis, dan es = bahasa Spanyol. Awalan bahasa menentukan dalam bahasa apa solusi dicantumkan: mengaturnya ke "en" akan mencantumkan solusi dengan terjemahan bahasa Inggris selama ada terjemahan bahasa Inggris - jika tidak, solusi akan dicantumkan dalam bahasa aslinya, yang dapat berupa bahasa Prancis atau Spanyol.

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

Anda dapat memodifikasi perilaku ini dan memaksa untuk hanya menerima solusi yang dipublikasikan dalam bahasa tertentu dengan menambahkan filter ke permintaan API Anda. Sebagai contoh: Jika Anda ingin menerima solusi yang diterjemahkan ke bahasa Spanyol, gunakan permintaan API berikut:

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

Harap pertimbangkan hal berikut ini:

  • Filter ditambahkan dengan menggunakan nama filter ("bahasa"), diikuti dengan tanda kurung siku [], tanda sama dengan, dan nilai. Lebih lanjut mengenai hal tersebut di bawah ini.
  • Jika Anda menambahkan filter "bahasa", Anda tidak secara otomatis menerima teks terjemahan yang sesuai. Ingatlah untuk mengubah awalan bahasa untuk menerima solusi yang diterjemahkan ke bahasa yang Anda inginkan.
  • Anda dapat menambahkan beberapa parameter permintaan dengan menambahkannya dengan "&" pada permintaan API.
https://panorama.solutions/es/api/v1/solutions?language[]=es&filter_lain[]=123

Pengurutan

Anda dapat mengubah pengurutan solusi yang Anda terima dari API kami. Untuk pengurutan, ada dua parameter yang tersedia: "sort_by" dan "sort_order" (yang bersifat opsional). Untuk "sort_order" Anda dapat mengatur "ASC" untuk urutan menaik dan "DESC" untuk urutan menurun. Harap diingat bahwa nilai "ASC" dan "DESC" untuk parameter "sort_order" harus ditulis dengan huruf besar. Jika tidak ada parameter "sort_order" yang ditetapkan, setiap opsi untuk "sorty_by" memiliki nilai default. Opsi untuk parameter "sort_by" adalah sebagai berikut:

Ketika Anda ingin mendapatkan solusi dalam urutan abjad menaik, Anda dapat menambahkan yang berikut ini ke permintaan Anda:


https://panorama.solutions/en/api/v1/solutions?sort_by=title_field&sort_order=ASC
  • changed: Mengurutkan berdasarkan tanggal solusi diubah terakhir kali untuk mendapatkan yang terbaru pertama (atau terakhir). Urutan default: DESC
  • title_field: Urutan abjad berdasarkan judul solusi. Urutan default: ASC
  • search_api_relevance: Relevansi solusi yang terkait dengan istilah pencarian - opsi pengurutan ini hanya berguna jika Anda menjalankan kueri terhadap pencarian kami yang akan dijelaskan nanti. Urutan default: DESC (relevansi tinggi terlebih dahulu)

Filter

Anda dapat menggunakan banyak filter untuk menyaring solusi yang sesuai dengan keinginan Anda.

Penting untuk diperhatikan bahwa filter perlu ditambahkan dengan tanda kurung siku pada permintaan API Anda karena setiap filter dapat digunakan beberapa kali. Sebagai contoh, untuk mendapatkan solusi yang terhubung dengan kategori "Agro-ekosistem" (dengan id 370) dari filter "Ekosistem", Anda perlu menambahkan hal berikut pada permintaan API Anda:

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

Hal ini memungkinkan untuk mengumpulkan solusi yang terhubung dengan kategori yang berbeda di dalam filter "Ekosistem". Jika Anda mungkin tertarik dengan solusi yang terkait dengan "Agro-ekosistem" dan "Ekosistem gurun" (yang memiliki id 33), Anda dapat menggunakan permintaan API berikut ini:

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

Untuk mendapatkan semua filter yang ingin Anda gunakan, Anda dapat menggunakan halaman PANORAMA Explorer - ketika Anda menggunakan penjelajah untuk memfilter pada bilah alamat browser, Anda akan menemukan URL dengan semua parameter yang Anda butuhkan. Anda dapat menggunakan parameter URL ini untuk menambahkannya ke jalur permintaan API PANORAMA. Perlu diingat bahwa Anda memiliki beberapa filter yang tersedia di API ini.

Mencari dengan istilah pencarian/kata kunci

Mirip dengan halaman PANORAMA Explorer, Anda dapat menjalankan pencarian untuk menemukan solusi yang terkait dengan satu atau beberapa kata kunci/istilah pencarian. Gunakan parameter "kata kunci" untuk ini:

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

Anda dapat menambahkan beberapa kata kunci untuk mempersempit pencarian, dengan menambahkan kata kunci yang dipisahkan oleh spasi yang dikodekan URL sehingga pencarian untuk "perikanan laut" akan terlihat seperti berikut:

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

Untuk permintaan API dengan istilah pencarian, Anda harus selalu menambahkan parameter pengurutan "sort_by" dengan nilai "search_api_relevance" untuk mendapatkan solusi-solusi yang lebih relevan dengan pencarian Anda:

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

Paging

Dalam setiap tanggapan, Anda akan menerima maksimal 20 solusi. API menawarkan paging sehingga Anda dapat menerima 20 solusi berikutnya dengan menambahkan parameter "page" pada permintaan Anda:

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

Respons tidak menyertakan informasi apa pun jika ada solusi di halaman 2 sehingga Anda perlu memeriksanya sendiri saat memanggil halaman berikutnya.

Meminta Solusi Tunggal dengan ID atau WDPA

Anda dapat menggunakan parameter &nid=NODE_ID dan &wdpa=NODE_ID

&nid
Untuk meminta satu Solusi, Anda dapat menggunakan Filter &nid
Anda dapat menemukan ID dengan meminta API (ini adalah bagian dari objek solusi) atau dengan melihat kode sumber HTML dari sebuah Solusi (lihat tag tubuh)

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

&wdpa
Solusi Kawasan Lindung berisi ID WDPA Planet Dilindungi.
Tanggapannya akan mencakup semua Solusi dengan ID yang cocok

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

Meminta Solusi berdasarkan kode ISO negara

Gunakan parameter &country_iso_2 untuk meminta Solusi yang difilter berdasarkan iso negara

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

Meminta Solusi berdasarkan Judul Portal

Gunakan parameter &portal_title untuk meminta Solusi yang difilter berdasarkan Portal yang ditugaskan. Judul portal dapat ditemukan sebagai bagian dari URL yang merupakan bagian dari halaman komunitas portal / tematik.

Contoh: https://panorama.solutions/en/portal/protected-areas
di mana protected-areas adalah judul portal yang sesuai yang dapat digunakan sebagai filter API.

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

Meminta Solusi berdasarkan ID Portal

Gunakan parameter &portal_id untuk meminta Solusi yang difilter berdasarkan ID Portal yang ditugaskan. ID Portal dapat ditemukan di URL saat mengedit halaman Portal.

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