Documentação da API

Para usar a API, adicione seu token de acesso à API PANORAMA à solicitação da API:

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

O URL da API PANORAMA é:

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

O prefixo do idioma pode ser definido como um dos três idiomas usados no PANORAMA: en = inglês, fr = francês e es = espanhol. O prefixo do idioma determina em que idioma as soluções são listadas: se for definido como "en", as soluções serão listadas com sua tradução em inglês, desde que haja uma tradução em inglês; caso contrário, a solução será listada em seu idioma original, que pode ser francês ou espanhol.

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

Você pode modificar esse comportamento e forçar o recebimento apenas das soluções publicadas em um idioma específico adicionando um filtro à sua solicitação de API. Por exemplo: Se você quiser receber soluções traduzidas para o espanhol, use a seguinte solicitação de API:

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

Considere o seguinte:

• Os filtros são adicionados usando o nome do filtro ("language"), seguido de colchetes [], o sinal de igual e o valor. Mais informações sobre isso abaixo.
• Se você adicionar o filtro "idioma", não receberá automaticamente os textos traduzidos correspondentes. Lembre-se de alterar o prefixo do idioma para receber as soluções traduzidas para o idioma de sua preferência.
• Você pode adicionar vários parâmetros de solicitação adicionando-os com "&" à solicitação da API.

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

Você pode alterar a classificação das soluções que recebe de nossa API. Para a classificação, há dois parâmetros disponíveis: "sort_by" e "sort_order" (que é opcional). Para "sort_order", você pode definir "ASC" para ordem ascendente e "DESC" para ordem descendente. Lembre-se de que os valores "ASC" e "DESC" do parâmetro "sort_order" precisam ser escritos em letras maiúsculas. Quando nenhum parâmetro "sort_order" é definido, cada opção de "sorty_by" tem um valor padrão. As opções para o parâmetro "sort_by" são as seguintes:

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

• changed: ordenação por data em que as soluções foram alteradas pela última vez para obter a última primeiro (ou última). Ordem padrão: DESC
• title_field: Ordem alfabética por título da solução. Ordem padrão: ASC
• search_api_relevance: Relevância das soluções relacionadas a um termo de pesquisa - essa opção de classificação só é útil se você executar uma consulta em relação à nossa pesquisa, que será explicada mais adiante. Ordem padrão: DESC (alta relevância primeiro)

Você pode usar vários filtros para filtrar apenas as soluções que são de seu interesse.

É importante observar que os filtros precisam ser adicionados com colchetes à sua solicitação de API, pois cada filtro pode ser usado várias vezes. Por exemplo, para obter soluções conectadas à categoria "Agroecossistema" (cujo ID é 370) do filtro "Ecossistema", você precisará adicionar o seguinte à sua solicitação de API:

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

Isso possibilita a coleta de soluções conectadas a diferentes categorias dentro do filtro "Ecosystem". Se você estiver interessado em soluções relacionadas a "Agro-ecosystem" e "Desert ecosystems" (que tem o ID 33), poderá usar a seguinte solicitação de API:

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

Para obter todos os filtros que deseja usar, você pode usar a página do PANORAMA Explorer - ao usar o explorador para filtragem na barra de endereços do navegador, você encontrará um URL com todos os parâmetros necessários. Você pode usar esses parâmetros de URL para adicioná-los ao caminho de solicitação da API do PANORAMA. Lembre-se de que você tem mais alguns filtros disponíveis nessa API.

Semelhante à página do PANORAMA Explorer, você pode executar uma pesquisa para encontrar soluções relacionadas a uma ou mais palavras-chave/termos de pesquisa. Use o parâmetro "keyword" para isso:

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

Você pode adicionar várias palavras-chave para restringir a pesquisa, adicionando palavras-chave separadas por espaços codificados por URL, de modo que uma pesquisa por "marine fisheries" (pesca marinha) seja semelhante à seguinte:

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

Para solicitações de API com termos de pesquisa, você deve sempre adicionar o parâmetro de classificação "sort_by" com o valor "search_api_relevance" para obter primeiro as soluções mais relevantes em relação à sua pesquisa:

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

Em cada resposta, você receberá no máximo 20 soluções. A API oferece uma paginação para que você possa receber as próximas 20 soluções adicionando o parâmetro "page" à sua solicitação:

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

A resposta não inclui nenhuma informação se houver soluções na página 2, portanto, você precisa verificar isso ao chamar a próxima página.

Você pode usar os parâmetros &nid=NODE_ID e &wdpa=NODE_ID

&nid
Para solicitar uma única solução, você pode usar o filtro &nid
Você pode encontrar o ID solicitando a API (ele faz parte do objeto da solução) ou observando o código-fonte HTML de uma solução (consulte a tag body)

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

&wdpa
As Soluções de Áreas Protegidas contêm a ID WDPA do Planeta Protegido.
A resposta incluirá todas as soluções com a ID correspondente

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

Use o parâmetro &country_iso_2 para solicitar soluções filtradas por ISO do país

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

Use o parâmetro &portal_title para solicitar soluções filtradas pelo portal ao qual estão atribuídas. O título do portal pode ser encontrado como parte da URL que pertence a uma página de portal/comunidade temática.

Por exemplo, https://panorama.solutions/en/portal/protected-areas
onde protected-areas é o título do portal correspondente que pode ser usado como um filtro de API.

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

Use o parâmetro &portal_id para solicitar soluções filtradas pelo ID do portal ao qual estão atribuídas. A ID do portal pode ser encontrada na URL ao editar uma página do portal.

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