Documentación API

La API de PANORAMA le permite mostrar casos prácticos de soluciones seleccionadas en su sitio web. Sólo se puede llamar/acceder a determinadas partes de la descripción de la solución, entre las que se incluyen varios filtros y opciones de clasificación para solicitar los datos de las soluciones que necesite. Esta documentación le ayuda a utilizar la API de PANORAMA y a encontrar la configuración correcta.

Autenticación

Para utilizar la API, añada su token de acceso a la API de PANORAMA a la solicitud de la API:

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

Uso básico e idioma de las soluciones

La URL de la API de PANORAMA es

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

El prefijo de idioma puede establecerse en uno de los tres idiomas utilizados en PANORAMA: en = inglés, fr = francés y es = español. El prefijo de idioma determina en qué idioma se mostrarán las soluciones: si se selecciona "en", se mostrarán las soluciones con su traducción al inglés, siempre que exista una traducción al inglés; de lo contrario, la solución se mostrará en su idioma original, que puede ser francés o español.

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

Puede modificar este comportamiento y forzar la recepción únicamente de las soluciones publicadas en un idioma específico añadiendo un filtro a su solicitud de API. Por ejemplo: Si desea recibir soluciones traducidas al español, utilice la siguiente solicitud de API:

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

Tenga en cuenta lo siguiente:

  • Los filtros se añaden utilizando el nombre del filtro ("idioma"), seguido de corchetes [], el signo igual y el valor. Más información a continuación.
  • Si añade el filtro "idioma" no recibirá automáticamente los textos traducidos correspondientes. Recuerde cambiar el prefijo de idioma para recibir las soluciones traducidas al idioma que prefiera.
  • Puede añadir varios parámetros de solicitud añadiéndolos con "&" a la solicitud de API.
https://panorama.solutions/es/api/v1/solutions?language[]=es&otro_filtro[]=123

Clasificación

Puede cambiar la clasificación de las soluciones que recibe de nuestra API. Para la clasificación, hay dos parámetros disponibles: "sort_by" y "sort_order" (que es opcional). En "sort_order" puede seleccionar "ASC" para el orden ascendente y "DESC" para el descendente. Tenga en cuenta que los valores "ASC" y "DESC" del parámetro "sort_order" deben escribirse con mayúsculas. Cuando no se establece el parámetro "sort_order" cada opción para "sorty_by" tiene un valor por defecto. Las opciones para el parámetro "sort_by" son las siguientes:

Si desea obtener las soluciones en orden alfabético ascendente, añada lo siguiente a su solicitud:


https://panorama.solutions/en/api/v1/solutions?sort_by=title_field&sort_order=ASC
  • changed: Ordenación por fecha en la que se modificaron las soluciones la última vez para obtener primero (o último) la más reciente. Orden por defecto: DESC
  • campo_título: Orden alfabético por título de la solución. Orden por defecto: ASC
  • search_api_relevance: Relevancia de las soluciones relacionadas con un término de búsqueda - esta opción de ordenación sólo es útil si ejecuta una consulta contra nuestra búsqueda que se explica más adelante. Orden por defecto: DESC (relevancia alta primero)

Filtros

Puede utilizar varios filtros para filtrar sólo las soluciones que le interesen.

Es importante tener en cuenta que los filtros deben añadirse entre corchetes a la solicitud API, ya que cada filtro puede utilizarse varias veces. Por ejemplo, para obtener soluciones relacionadas con la categoría "Agro-ecosistema" (cuyo id es 370) a partir del filtro "Ecosistema", tendrá que añadir lo siguiente a su solicitud de API:

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

Esto permite recopilar soluciones relacionadas con diferentes categorías dentro del filtro "Ecosistema". Si está interesado en soluciones relacionadas con "Agroecosistema" y "Ecosistemas desérticos" (que tiene el id 33), puede utilizar la siguiente solicitud de API:

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

Para obtener todos los filtros que desea utilizar puede utilizar la página del Explorador de PANORAMA - cuando utilice el explorador para filtrar en la barra de direcciones del navegador encontrará una URL con todos los parámetros que necesita. Puede utilizar estos parámetros de URL para añadirlos a la ruta de solicitud de la API de PANORAMA. Tenga en cuenta que dispone de algunos filtros más en esta API.

Búsqueda con términos de búsqueda/palabras clave

De forma similar a la página del Explorador de PANORAMA, puede realizar una búsqueda para encontrar soluciones relacionadas con una o más palabras clave/términos de búsqueda. Utilice para ello el parámetro "palabra clave":

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

Puede añadir varias palabras clave para acotar la búsqueda, añadiendo palabras clave separadas por espacios codificados en la URL, de modo que una búsqueda de "pesca marina" tendrá el siguiente aspecto:

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

Para las solicitudes de API con términos de búsqueda, añada siempre el parámetro de ordenación "sort_by" con el valor "search_api_relevance" para obtener primero las soluciones más relevantes para su búsqueda:

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

Paginación

En cada respuesta recibirá un máximo de 20 soluciones. La API ofrece una paginación para que pueda recibir las 20 soluciones siguientes añadiendo el parámetro "page" a su solicitud:

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

La respuesta no incluye información sobre si hay soluciones en la página 2, por lo que deberá comprobarlo usted mismo al llamar a la página siguiente.

Solicitud de una única solución por ID o WDPA

Puede utilizar los parámetros &nid=ID_NODO y &wdpa=ID_NODO

&nid
Para solicitar una única solución puede utilizar el filtro &nid
Puede encontrar el ID solicitándolo a la API (forma parte del objeto de la solución) o consultando el código fuente HTML de una solución (consulte la etiqueta body)

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

&wdpa
Áreas protegidas Las soluciones contienen el ID de la WDPA del planeta protegido.
La respuesta incluirá todas las soluciones con el ID correspondiente.

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

Solicitud de soluciones por códigos ISO de país

Utilice el parámetro &country_iso_2 para solicitar Soluciones filtradas por país iso

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

Solicitud de soluciones por título del portal

Utilice el parámetro &portal_title para solicitar soluciones filtradas por el portal al que están asignadas. El Título del portal puede encontrarse como parte de la URL que pertenece a un portal / página de comunidad temática.

Por ejemplo: https://panorama.solutions/en/portal/protected-areas
donde protected-areas es el título del portal correspondiente que puede utilizarse como filtro de la API.

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

Solicitud de soluciones por ID de portal

Utilice el parámetro &portal_id para solicitar soluciones filtradas por el ID del portal al que están asignadas. El ID del portal se puede encontrar en la URL al editar una página del portal.

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