Documentation de l'API

L'API PANORAMA vous permet d'afficher des études de cas de solutions sélectionnées sur votre site web. Seules certaines parties de la description de la solution peuvent être appelées/accédées, notamment plusieurs filtres et options de tri pour demander les données de solutions dont vous avez besoin. Cette documentation vous aide à utiliser l'API PANORAMA et à trouver les paramètres corrects.

Authentification

Pour utiliser l'API, ajoutez votre jeton d'accès à l'API PANORAMA à la demande d'API :

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

Utilisation de base et langue des solutions

L'URL de l'API PANORAMA est la suivante :

https://panorama.solutions/{préfixe_langue}/api/v1/solutions

Le préfixe de langue peut être défini comme l'une des trois langues utilisées sur PANORAMA : en = anglais, fr = français et es = espagnol. Le préfixe de langue détermine la langue dans laquelle les solutions sont répertoriées : si le préfixe est "en", les solutions seront répertoriées avec leur traduction en anglais, pour autant qu'il existe une traduction en anglais ; sinon, la solution sera répertoriée dans sa langue d'origine, qui peut être le français ou l'espagnol.

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

Vous pouvez modifier ce comportement et forcer la réception des solutions publiées dans une langue spécifique en ajoutant un filtre à votre demande d'API. Par exemple, si vous souhaitez recevoir les solutions qui sont publiées dans une langue spécifique, ajoutez un filtre à votre demande API : Si vous souhaitez recevoir les solutions traduites en espagnol, utilisez la requête API suivante :

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

Veuillez tenir compte de ce qui suit :

  • Les filtres sont ajoutés en utilisant le nom du filtre ("langue"), suivi de crochets [], du signe égal et de la valeur. Vous trouverez plus d'informations à ce sujet ci-dessous.
  • Si vous ajoutez le filtre "langue", vous ne recevrez pas automatiquement les textes traduits correspondants. N'oubliez pas de modifier le préfixe de langue pour recevoir les solutions traduites dans la langue de votre choix.
  • Vous pouvez ajouter plusieurs paramètres de demande en les ajoutant avec "&" à la demande API.
https://panorama.solutions/es/api/v1/solutions?language[]=es&another_filter[]=123

Tri

Vous pouvez modifier le tri des solutions que vous recevez de notre API. Pour le tri, deux paramètres sont disponibles : "sort_by" et "sort_order" (qui est facultatif). Pour "sort_order", vous pouvez définir "ASC" pour l'ordre croissant et "DESC" pour l'ordre décroissant. N'oubliez pas que les valeurs "ASC" et "DESC" du paramètre "sort_order" doivent être écrites en majuscules. Lorsqu'aucun paramètre "sort_order" n'est défini, chaque option de "sorty_by" a une valeur par défaut. Les options du paramètre "sort_by" sont les suivantes :

Si vous souhaitez obtenir les solutions par ordre alphabétique croissant, vous devez ajouter ce qui suit à votre requête :


https://panorama.solutions/en/api/v1/solutions?sort_by=title_field&sort_order=ASC
  • changed: tri par date à laquelle les solutions ont été modifiées la dernière fois pour obtenir la plus récente en premier (ou en dernier). Ordre par défaut : DESC
  • title_field: Ordre alphabétique par titre de la solution. Ordre par défaut : ASC
  • search_api_relevance: Pertinence des solutions liées à un terme de recherche - cette option de tri n'est utile que si vous lancez une requête à l'aide de notre moteur de recherche, qui est expliqué plus loin. Ordre par défaut : DESC (pertinence élevée en premier)

Filtres

Vous pouvez utiliser de nombreux filtres pour ne retenir que les solutions qui vous intéressent.

Il est important de noter que les filtres doivent être ajoutés entre crochets à votre demande d'API, car chaque filtre peut être utilisé plusieurs fois. Par exemple, pour obtenir les solutions liées à la catégorie "Agro-écosystème" (dont l'identifiant est 370) à partir du filtre "Écosystème", vous devrez ajouter ce qui suit à votre demande d'API :

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

Cela permet de collecter des solutions liées à différentes catégories au sein du filtre "Ecosystème". Si vous êtes intéressé par les solutions liées à "Agro-ecosystem" et "Desert ecosystems" (qui a l'id 33), vous pouvez utiliser la requête API suivante :

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

Pour obtenir tous les filtres que vous souhaitez utiliser, vous pouvez utiliser la page PANORAMA Explorer - lorsque vous utilisez l'explorateur de filtrage dans la barre d'adresse du navigateur, vous trouverez une URL avec tous les paramètres dont vous avez besoin. Vous pouvez utiliser ces paramètres URL pour les ajouter au chemin de requête de l'API PANORAMA. N'oubliez pas que d'autres filtres sont disponibles dans cette API.

Recherche avec des termes de recherche / mots-clés

Comme pour la page PANORAMA Explorer, vous pouvez lancer une recherche pour trouver des solutions liées à un ou plusieurs mots-clés/termes de recherche. Pour ce faire, utilisez le paramètre "keyword" :

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

Vous pouvez ajouter plusieurs mots-clés pour affiner la recherche, en ajoutant des mots-clés séparés par des espaces codés par l'URL, de sorte qu'une recherche pour "pêcheries marines" ressemblera à ce qui suit :

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

Pour les requêtes API avec des termes de recherche, vous devez toujours ajouter le paramètre de tri "sort_by" avec la valeur "search_api_relevance" pour obtenir en premier les solutions qui sont les plus pertinentes par rapport à votre recherche :

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

Pagination

Dans chaque réponse, vous recevrez au maximum 20 solutions. L'API propose une pagination qui vous permet de recevoir les 20 solutions suivantes en ajoutant le paramètre "page" à votre demande :

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

La réponse n'indique pas s'il y a des solutions à la page 2. Vous devez donc le vérifier vous-même lorsque vous appelez la page suivante.

Demande d'une solution unique par ID ou WDPA

Vous pouvez utiliser les paramètres &nid=NODE_ID et &wdpa=NODE_ID

&nid
Pour demander une solution unique, vous pouvez utiliser le filtre &nid.
Vous pouvez trouver l'ID en demandant l'API (il fait partie de l'objet solution) ou en regardant le code source HTML d'une solution (voir la balise body).

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

&wdpa
Protected Areas Solutions contient l'identifiant Protected Planet WDPA.
La réponse comprendra toutes les solutions avec l'identifiant correspondant.

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

Demande de solutions par code ISO de pays

Utilisez le paramètre &country_iso_2 pour demander des solutions filtrées par pays ISO.

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

Demande de solutions par titre de portail

Utilisez le paramètre &portal_title pour demander des solutions filtrées par le portail auquel elles sont affectées. Le titre du portail peut être trouvé dans l'URL d'un portail ou d'une page d'une communauté thématique.

Par exemple : https://panorama.solutions/en/portal/protected-areas
où protected-areas est le titre du portail correspondant qui peut être utilisé comme filtre API.

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

Demande de solutions par identifiant de portail

Utilisez le paramètre &portal_id pour demander des solutions filtrées par l'ID du portail auquel elles sont affectées. L'ID du portail peut être trouvé dans l'URL lors de l'édition d'une page du portail.

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