API-Dokumentation

Um die API zu nutzen, fügen Sie Ihr PANORAMA-API-Zugangs-Token zur API-Anfrage hinzu:

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

Die URL der PANORAMA-API lautet:

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

Das Sprachpräfix kann auf eine der drei auf PANORAMA verwendeten Sprachen eingestellt werden: en = Englisch, fr = Französisch und es = Spanisch. Das Sprachpräfix bestimmt, in welcher Sprache die Lösungen aufgelistet werden: Wenn es auf "en" gesetzt wird, werden die Lösungen mit ihrer englischen Übersetzung aufgelistet, sofern es eine englische Übersetzung gibt - andernfalls wird die Lösung in ihrer Originalsprache aufgelistet, die Französisch oder Spanisch sein kann.

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

Sie können dieses Verhalten ändern und erzwingen, dass Sie nur die Lösungen erhalten, die in einer bestimmten Sprache veröffentlicht wurden, indem Sie einen Filter zu Ihrer API-Anfrage hinzufügen. Zum Beispiel: Wenn Sie Lösungen erhalten möchten, die ins Spanische übersetzt sind, verwenden Sie die folgende API-Anfrage:

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

Bitte beachten Sie das Folgende:

• Filter werden hinzugefügt, indem Sie den Filternamen ("Sprache") verwenden, gefolgt von eckigen Klammern [], dem Gleichheitszeichen und dem Wert. Mehr dazu weiter unten.
• Wenn Sie den Filter "Sprache" hinzufügen, erhalten Sie nicht automatisch die entsprechenden übersetzten Texte. Denken Sie daran, das Sprachpräfix zu ändern, um die Lösungen in der von Ihnen bevorzugten Sprache zu erhalten.
• Sie können mehrere Anfrageparameter hinzufügen, indem Sie sie mit "&" an die API-Anfrage anhängen.

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

Sie können die Sortierung der Lösungen, die Sie von unserer API erhalten, ändern. Für die Sortierung gibt es zwei Parameter: "sort_by" und "sort_order" (dieser ist optional). Für "sort_order" können Sie "ASC" für aufsteigende Reihenfolge und "DESC" für absteigende Reihenfolge einstellen. Bitte beachten Sie, dass die Werte "ASC" und "DESC" für den Parameter "sort_order" in Großbuchstaben geschrieben werden müssen. Wenn kein Parameter "sort_order" gesetzt ist, hat jede Option für "sorty_by" einen Standardwert. Die Optionen für den "sort_by"-Parameter sind die folgenden:

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

• changed: Sortierung nach dem Datum, an dem die Lösungen das letzte Mal geändert wurden, um die neuesten zuerst (oder zuletzt) zu erhalten. Standardreihenfolge: DESC
• titel_feld: Alphabetische Reihenfolge nach dem Titel der Lösung. Voreingestellte Reihenfolge: ASC
• such_api_relevanz: Relevanz der Lösungen in Bezug auf einen Suchbegriff - diese Sortieroption ist nur nützlich, wenn Sie eine Abfrage gegen unsere Suche durchführen, die später erklärt wird. Voreingestellte Reihenfolge: DESC (hohe Relevanz zuerst)

Sie können zahlreiche Filter verwenden, um genau die Lösungen herauszufiltern, die für Sie von Interesse sind.

Es ist wichtig zu beachten, dass Filter mit eckigen Klammern zu Ihrer API-Anfrage hinzugefügt werden müssen, da jeder Filter mehrfach verwendet werden kann. Um zum Beispiel Lösungen, die mit der Kategorie "Agro-Ökosystem" (mit der ID 370) verbunden sind, über den Filter "Ökosystem" zu erhalten, müssen Sie Ihrer API-Anfrage Folgendes hinzufügen:

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

Dies ermöglicht es, Lösungen zu sammeln, die mit verschiedenen Kategorien innerhalb des Filters "Ökosystem" verbunden sind. Wenn Sie an Lösungen im Zusammenhang mit "Agrarökosystem" und "Wüstenökosysteme" (mit der ID 33) interessiert sind, können Sie die folgende API-Anfrage verwenden:

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

Um alle gewünschten Filter zu erhalten, können Sie die Seite des PANORAMA-Explorers verwenden - wenn Sie den Explorer zum Filtern verwenden, finden Sie in der Adressleiste des Browsers eine URL mit allen benötigten Parametern. Sie können diese URL-Parameter verwenden, um sie dem PANORAMA-API-Anfragepfad hinzuzufügen. Denken Sie daran, dass Ihnen in dieser API noch weitere Filter zur Verfügung stehen.

Ähnlich wie auf der Seite PANORAMA Explorer können Sie eine Suche durchführen, um Lösungen zu finden, die mit einem oder mehreren Schlüsselwörtern/Suchbegriffen in Verbindung stehen. Verwenden Sie dazu den Parameter "keyword":

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

Sie können mehrere Schlüsselwörter hinzufügen, um die Suche einzugrenzen, indem Sie die Schlüsselwörter durch URL-verschlüsselte Leerzeichen getrennt hinzufügen, so dass eine Suche nach "Meeresfischerei" wie folgt aussieht:

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

Bei API-Anfragen mit Suchbegriffen sollten Sie immer den Sortierparameter "sort_by" mit dem Wert "search_api_relevance" hinzufügen, um zuerst die Lösungen zu erhalten, die für Ihre Suche am relevantesten sind:

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

In jeder Antwort erhalten Sie maximal 20 Lösungen. Die API bietet ein Paging, so dass Sie die nächsten 20 Lösungen erhalten können, indem Sie den Parameter "page" zu Ihrer Anfrage hinzufügen:

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

Die Antwort enthält keine Informationen darüber, ob es Lösungen auf Seite 2 gibt, so dass Sie dies selbst überprüfen müssen, wenn Sie die nächste Seite aufrufen.

Sie können die Parameter &nid=NODE_ID und &wdpa=NODE_ID verwenden

&nid
Um eine einzelne Lösung anzufordern, können Sie den Filter &nid verwenden.
Sie können die ID finden, indem Sie API anfordern (sie ist Teil des Solution-Objekts) oder indem Sie sich den HTML-Quellcode einer Solution ansehen (siehe Body-Tag)

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

&wdpa
Protected Areas Solutions enthält die Protected Planet WDPA ID.
Die Antwort enthält alle Lösungen mit der entsprechenden ID

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

Verwenden Sie den Parameter &country_iso_2, um nach Länder-ISO gefilterte Lösungen anzufordern

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

Verwenden Sie den Parameter &portal_title, um nach dem Portal, dem sie zugeordnet sind, gefilterte Lösungen anzufordern. Der Portaltitel kann als Teil der URL gefunden werden, die zu einem Portal / einer thematischen Gemeinschaftsseite gehört.

Z.B. https://panorama.solutions/en/portal/protected-areas
wobei protected-areas der entsprechende Portaltitel ist, der als API-Filter verwendet werden kann.

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

Verwenden Sie den Parameter &portal_id, um Lösungen anzufordern, die nach der Portal-ID gefiltert sind, der sie zugeordnet sind. Die Portal-ID kann in der URL gefunden werden, wenn eine Portalseite bearbeitet wird.

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