Документация API

Чтобы воспользоваться API, добавьте в запрос API свой токен доступа к PANORAMA API:

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

URL-адрес PANORAMA API следующий:

https://panorama.solutions/{языковой_префикс}/api/v1/solutions.

Префикс языка может быть установлен на один из трех языков, используемых в PANORAMA: en = английский, fr = французский и es = испанский. Префикс языка определяет, на каком языке будут перечислены решения: при установке значения "en" решения будут перечислены с их английским переводом, если только существует английский перевод - в противном случае решение будет перечислено на языке оригинала, который может быть французским или испанским.

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

Вы можете изменить сортировку решений, которые вы получаете от нашего API. Для сортировки доступны два параметра: "sort_by" и "sort_order" (который является необязательным). Для параметра "sort_order" вы можете задать значение "ASC" для сортировки по возрастанию и "DESC" для сортировки по убыванию. Пожалуйста, помните, что значения "ASC" и "DESC" для параметра "sort_order" должны быть написаны в верхнем регистре. Когда параметр "sort_order" не задан, каждый параметр для "sorty_by" имеет значение по умолчанию. Параметры для параметра "sort_by" могут быть следующими:

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

• changed: Сортировка по дате, когда решения были изменены в последний раз, чтобы получить последние решения первыми (или последними). Порядок по умолчанию: DESC
• title_field: Алфавитный порядок по названию решения. Порядок по умолчанию: ASC
• search_api_relevance: Релевантность решений, связанных с поисковым термином - эта опция сортировки полезна, если вы выполняете запрос к нашему поиску, о котором мы расскажем позже. Порядок по умолчанию: DESC (сначала высокая релевантность)

Вы можете использовать множество фильтров, чтобы отсеять только те решения, которые вас интересуют.

Важно отметить, что фильтры должны быть добавлены в квадратных скобках к вашему API-запросу, поскольку каждый фильтр может быть использован несколько раз. Например, чтобы получить решения, связанные с категорией "Агроэкосистема" (идентификатор которой 370), из фильтра "Экосистема", вам нужно добавить следующее в ваш запрос API:

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

Это позволит собирать решения, относящиеся к разным категориям в рамках фильтра "Экосистема". Если вас интересуют решения, связанные с "Агроэкосистемой" и "Пустынными экосистемами" (которые имеют идентификатор 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 предлагает возможность постраничной выдачи, чтобы вы могли получить следующие 20 решений, добавив в запрос параметр "page":

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

Ответ не содержит информации о том, есть ли решения на странице 2, поэтому вы должны проверить это самостоятельно при вызове следующей страницы.

Вы можете использовать параметры &nid=NODE_ID и &wdpa=NODE_ID

&nid 
Для запроса отдельного решения вы можете использовать фильтр &nid
Вы можете найти ID, запросив API (он является частью объекта решения) или посмотрев HTML исходный код решения (см. тег body)

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

&wdpa
Решения для охраняемых территорий содержат идентификатор охраняемой планеты WDPA.
Ответ будет включать все решения с соответствующим идентификатором

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

Используйте параметр &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

Используйте параметр &portal_id для запроса решений, отфильтрованных по идентификатору портала, которому они присвоены. Идентификатор портала можно найти в URL при редактировании страницы портала.

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