应用程序接口文档

PANORAMA API 允许您在网站上显示选定的解决方案案例研究。只能调用/访问解决方案描述的某些部分，其中包括多个筛选器和排序选项，以获取所需的解决方案数据。本文档可帮助您使用 PANORAMA API 并找到正确的设置。

验证

要使用 API，请在 API 请求中添加您的 PANORAMA API 访问令牌：

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

解决方案的基本用法和语言

PANORAMA API 的 URL 是

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

语言前缀可设置为 PANORAMA 使用的三种语言之一：en = 英语、fr = 法语和 es = 西班牙语。语言前缀决定用哪种语言列出解决方案：设置为"en "时，只要有英文翻译，就会用英文翻译列出解决方案；否则，解决方案将用其原始语言（法语或西班牙语）列出。

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

您可以通过在 API 请求中添加过滤器来修改此行为，并强制只接收以特定语言发布的解决方案。例如如果您想接收翻译成西班牙语的解决方案，请使用以下 API 请求：

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

请注意以下几点：

  • 添加过滤器时要使用过滤器名称（"语言"）、方括号 [] 、等号和值。下文将详细介绍。
  • 如果您添加了 "语言 "过滤器，您不会自动收到相应的翻译文本。请记住更改语言前缀，以便接收翻译成您喜欢的语言的解决方案。
  • 您可以通过在 API 请求中添加"&"来添加多个请求参数。
https://panorama.solutions/es/api/v1/solutions?language[]=es&another_filter[]=123

排序

您可以更改从我们的 API 收到的解决方案的排序。有两个参数可用于排序："sort_by "和 "sort_order"（可选）。对于 "sort_order"，您可以设置 "ASC "表示升序，"DESC "表示降序。请注意，"sort_order "参数中的 "ASC "和 "DESC "必须用大写字母书写。如果没有设置 "sort_order "参数，"sorty_by "的每个选项都有一个默认值。sort_by "参数的选项如下：

如果想按字母升序获取解决方案，可以在请求中添加以下内容：


https://panorama.solutions/en/api/v1/solutions?sort_by=title_field&sort_order=ASC
  • 已更改：按解决方案上次更改的日期排序，以获得最新的第一个（或最后一个）。默认顺序：DESC
  • title_field：按解决方案标题的字母顺序排列。默认顺序：ASCASC
  • search_api_relevance：与搜索词相关的解决方案的相关性 - 该排序选项仅在您根据我们的搜索进行查询时有用。默认顺序：DESC（相关度高的优先）

筛选器

您可以使用多种筛选器来筛选出您感兴趣的解决方案。

需要注意的是，过滤器需要用方括号添加到 API 请求中，因为每个过滤器可以多次使用。例如，要从过滤器 "生态系统 "中获取与类别 "农业生态系统"（id 为 370）相关的解决方案，您需要在 API 请求中添加以下内容：

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

这样就可以在 "生态系统 "过滤器中收集与不同类别相关的解决方案。如果您对与 "农业生态系统 "和 "沙漠生态系统"（id 为 33）相关的解决方案感兴趣，可以使用以下 API 请求：

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

要获得您想使用的所有筛选器，您可以使用PANORAMA Explorer 页面--当您使用浏览器地址栏中的筛选器时，您会发现一个包含您需要的所有参数的 URL。您可以使用这些 URL 参数将它们添加到 PANORAMA API 请求路径中。请记住，该 API 中还有更多可用的过滤器。

使用搜索条件/关键字搜索

与PANORAMA Explorer 页面类似，您可以运行搜索以查找与一个或多个关键字/搜索词相关的解决方案。为此请使用 "关键词 "参数：

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

您可以添加多个关键字来缩小搜索范围，添加的关键字可以用 URL 编码的空格分隔，这样搜索 "海洋渔业 "就会如下所示：

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

对于带有搜索词的 API 请求，您应始终添加排序参数 "sort_by"（值为 "search_api_relevance"），以便首先获得与您的搜索更相关的解决方案：

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

分页

在每个响应中，您最多将收到 20 个解决方案。API 提供分页功能，您可以通过在请求中添加 "page "参数来接收下一个 20 个解决方案：

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

如果第 2 页有解决方案，则响应不包含任何信息，因此您需要在调用下一页时自行检查。

通过 ID 或 WDPA 请求单个解决方案

您可以使用参数&nid=NODE_ID和&wdpa=NODE_ID

nid
要请求单个解决方案，可以使用 &nid 过滤器
您可以通过请求 API（它是解决方案对象的一部分）或查看解决方案的 HTML 源代码（参见 body 标签）来查找 ID。

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

保护区
保护区解决方案包含受保护星球WDPA ID。
响应将包括具有匹配 ID 的所有解决方案

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

按国家 ISO 代码请求解决方案

使用参数&country_iso_2申请按国家 ISO 筛选的解决方案

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

按门户标题请求解决方案

使用参数&portal_title可按分配给哪个门户来筛选解决方案。门户标题可以在属于门户/专题社区页面的 URL 中找到。

例如：https://panorama.solutions/en/portal/protected-areas
其中protected-areas是相应的门户标题，可用作 API 过滤器。

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

通过门户 ID 申请解决方案

使用参数&portal_id可按分配给它的门户 ID 筛选解决方案。门户 ID 可以在编辑门户页面时在 URL 中找到。

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