파노라마 API를 사용하면 선택한 솔루션 사례 연구를 웹사이트에 표시할 수 있습니다. 솔루션 설명의 특정 부분만 호출하거나 액세스할 수 있으며, 여기에는 필요한 솔루션 데이터를 요청하기 위한 여러 필터와 정렬 옵션이 포함되어 있습니다. 이 문서는 PANORAMA API를 사용하고 올바른 설정을 찾는 데 도움이 됩니다.
인증
API를 사용하려면 API 요청에 PANORAMA API 액세스 토큰을 추가하세요:
https://panorama.solutions/en/api/v1/solutions?api_key=1234
솔루션의 기본 사용법 및 언어
PANORAMA API의 URL은 다음과 같습니다:
https://panorama.solutions/{언어_접두사}/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
변경됨
: 솔루션이 마지막으로 변경된 날짜별로 정렬하여 가장 최근(또는 마지막)의 솔루션을 먼저 가져옵니다. 기본 순서입니다: DESCtitle_field
: 솔루션의 제목을 알파벳순으로 정렬합니다. 기본 순서입니다: ASCSEARCH_API_관련성
: 검색어와 관련된 솔루션의 관련성 - 이 정렬 옵션은 나중에 설명하는 검색에 대해 쿼리를 실행하는 경우에만 유용합니다. 기본 순서: 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
사용하려는 모든 필터를 얻으려면 파노라마 탐색기 페이지를 사용하면 됩니다. 브라우저 주소창에서 필터링용 탐색기를 사용하면 필요한 모든 매개변수가 포함된 URL을 찾을 수 있습니다. 이 URL 매개변수를 사용하여 PANORAMA API 요청 경로에 추가할 수 있습니다. 이 API에는 더 많은 필터를 사용할 수 있다는 점을 기억하세요.
검색어/키워드로 검색하기
파노라마 탐색기 페이지와 마찬가지로 하나 이상의 키워드/검색어와 관련된 솔루션을 찾기 위해 검색을 실행할 수 있습니다. 이를 위해 "키워드" 매개변수를 사용하세요:
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 소스 코드를 확인하여 ID를 찾을 수 있습니다(본문 태그 참조).
https://panorama.solutions/es/api/v1/solutions?api_key=123456&nid=115
&wdpa
보호 지역 솔루션에는 보호 지역 WDPA ID가 포함되어 있습니다.
응답에는 일치하는 ID를 가진 모든 솔루션이 포함됩니다.
https://panorama.solutions/es/api/v1/solutions?api_key=123456&wdpa=115
국가별 ISO 코드로 솔루션 요청하기
국가 ISO별로 필터링된 솔루션을 요청하려면 &country_iso_2 매개변수를 사용하세요.
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로 솔루션 요청하기
할당된 포털 ID로 필터링된 솔루션을 요청하려면 &portal_id 매개변수를 사용합니다. 포털 ID는 포털 페이지를 편집할 때 URL에서 찾을 수 있습니다.
https://panorama.solutions/es/api/v1/solutions?api_key=123456&portal_id=4673