API-documentatie

Om de API te gebruiken voegt u uw PANORAMA API toegangstoken toe aan het API-verzoek:

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

De URL van de PANORAMA API is:

https://panorama.solutions/{taal_voorvoegsel}/api/v1/oplossingen

De taal prefix kan worden ingesteld op één van de drie talen die op PANORAMA worden gebruikt: en = Engels, fr = Frans en es = Spaans. Het taalvoorvoegsel bepaalt in welke taal de oplossingen worden weergegeven: door het in te stellen op "en" worden de oplossingen weergegeven met hun Engelse vertaling zolang er een Engelse vertaling is - anders wordt de oplossing weergegeven in de oorspronkelijke taal die Frans of Spaans kan zijn.

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

Je kunt de sortering wijzigen van de oplossingen die je ontvangt van onze API. Voor sorteren zijn er twee parameters beschikbaar: "sort_by" en "sort_order" (die optioneel is). Voor "sort_order" kun je "ASC" instellen voor oplopende volgorde en "DESC" voor aflopende volgorde. Houd er rekening mee dat de waarden "ASC" en "DESC" voor de parameter "sort_order" met hoofdletters geschreven moeten worden. Als er geen parameter "sort_order" is ingesteld, heeft elke optie voor "sorty_by" een standaardwaarde. De opties voor de "sort_by" parameter zijn de volgende:

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

• gewijzigd: Sorteren op datum waarop de oplossingen de laatste keer zijn gewijzigd om de nieuwste eerst (of laatst) te krijgen. Standaard volgorde: DESC
• titel_veld: Alfabetische volgorde op titel van de oplossing. Standaard volgorde: ASC
• search_api_relevance: Relevantie van de oplossingen gerelateerd aan een zoekterm - deze sorteeroptie is alleen nuttig als je een query uitvoert tegen onze zoekfunctie die later wordt uitgelegd. Standaard volgorde: DESC (hoge relevantie eerst)

Je kunt veel filters gebruiken om alleen die oplossingen eruit te filteren die voor jou interessant zijn.

Het is belangrijk om te weten dat filters tussen vierkante haakjes moeten worden toegevoegd aan je API-verzoek, omdat elk filter meerdere keren kan worden gebruikt. Bijvoorbeeld, om oplossingen te krijgen die verbonden zijn met categorie "Agro-ecosysteem" (welke id 370 is) van de filter "Ecosysteem", moet je het volgende toevoegen aan je API verzoek:

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

Dit maakt het mogelijk om oplossingen te verzamelen die verbonden zijn met verschillende categorieën binnen het filter "Ecosysteem". Als je geïnteresseerd bent in oplossingen gerelateerd aan "Agro-ecosysteem" en "Woestijn ecosystemen" (die id 33 heeft) kun je het volgende API-verzoek gebruiken:

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

Om alle filters te krijgen die je wilt gebruiken kun je de PANORAMA Explorer pagina gebruiken - als je de verkenner voor het filteren in de adresbalk van de browser gebruikt vind je een URL met alle parameters die je nodig hebt. Je kunt deze URL-parameters gebruiken om ze toe te voegen aan het PANORAMA API request path. Houd er rekening mee dat er nog meer filters beschikbaar zijn in deze API.
 

Vergelijkbaar met de PANORAMA Explorer pagina kunt u een zoekopdracht uitvoeren om oplossingen te vinden die gerelateerd zijn aan een of meer trefwoorden/zoektermen. Gebruik hiervoor de "trefwoord" parameter:

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

U kunt meerdere trefwoorden toevoegen om de zoekopdracht te verfijnen, door trefwoorden gescheiden door URL-gecodeerde spaties toe te voegen, zodat een zoekopdracht naar "zeevisserij" er als volgt uitziet:

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

Voor API-verzoeken met zoektermen moet je altijd de sorteerparameter "sort_by" met waarde "search_api_relevance" toevoegen om eerst de oplossingen te krijgen die relevanter zijn voor je zoekopdracht:

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

In elk antwoord ontvangt u maximaal 20 oplossingen. De API biedt een paginering zodat u de volgende 20 oplossingen kunt ontvangen door de "page" parameter aan uw verzoek toe te voegen:

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

De respons bevat geen informatie of er oplossingen zijn op pagina 2, dus u moet dit zelf controleren wanneer u de volgende pagina oproept.

U kunt de parameters &nid=NODE_ID en &wdpa=NODE_ID gebruiken

&nid 
Om een enkele oplossing aan te vragen kunt u het &nid filter gebruiken.
U kunt het ID vinden door de API op te vragen (het is onderdeel van het solution object) of door naar de HTML broncode van een solution te kijken (zie body tag)

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

&wdpa
Protected Areas Oplossingen bevatten de Protected Planet WDPA ID.
Het antwoord zal alle oplossingen met de overeenkomende ID bevatten

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

Gebruik de parameter &country_iso_2 om oplossingen op te vragen gefilterd op land iso
 

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

Gebruik de parameter &portal_title om oplossingen op te vragen gefilterd door het portaal waaraan ze zijn toegewezen. De portaaltitel kan gevonden worden als deel van de URL die bij een portaal / thematische gemeenschapspagina hoort.

Bijv. https://panorama.solutions/en/portal/protected-areas
waarbij protected-areas de bijbehorende portaaltitel is die kan worden gebruikt als API-filter.

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

Gebruik de parameter &portal_id om oplossingen op te vragen gefilterd op de portaal-ID waaraan ze zijn toegewezen. Het portaal-ID kan worden gevonden in de URL bij het bewerken van een portaalpagina.

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