PANORAMA 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で使用されている3つの言語(en = 英語、fr = フランス語、es = スペイン語)のいずれかを設定できます。言語プレフィックスは、ソリューションをどの言語で表示するかを決定します。"en "に設定すると、英語の翻訳がある限り、ソリューションが英語の翻訳と共に表示されます。
https://panorama.solutions/en/api/v1/solutions
APIリクエストにフィルタを追加することで、この動作を変更し、特定の言語で公開されているソリューションのみを強制的に受け取ることができます。例えばスペイン語に翻訳されたソリューションを受信したい場合は、次のAPIリクエストを使用します:
https://panorama.solutions/es/api/v1/solutions?language[]=es
以下の点を考慮してください:
- フィルターは、フィルター名("language")、角括弧[]、等号、値の順に使用して追加します。詳しくは後述します。
- language "というフィルターを追加しても、対応する翻訳されたテキストを自動的に受け取ることはできません。ご希望の言語に翻訳されたソリューションを受け取るには、言語プレフィックスを変更することを忘れないでください。
- APIリクエストに"&"で複数のリクエストパラメータを追加することができます。
https://panorama.solutions/es/api/v1/solutions?language[]=es&another_filter[]=123
ソート
APIから受け取るソリューションのソートを変更することができます。ソートには2つのパラメータがあります:「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
changed
: 解答が最後に変更された日付でソートし、最新のものから取得します。デフォルトの並び順DESCtitle_field
:解決策のタイトルによるアルファベット順。デフォルト順:ASCsearch_api_relevance
:検索用語に関連するソリューションの関連性 - このソートオプションは、後で説明する検索に対してクエリを実行する場合に便利です。デフォルトの並び順:DESC (関連性の高いものから)
フィルター
多くのフィルターを使用して、興味のあるソリューションだけを絞り込むことができます。
各フィルターは複数回使用できるため、フィルターはAPIリクエストに角括弧で追加する必要があることに注意してください。例えば、"Ecosystem "というフィルターから "Agro-ecosystem"(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ではさらにいくつかのフィルターが利用できることを覚えておいてください。
検索語/キーワードによる検索
PANORAMA Explorerページと同様に、1つまたは複数のキーワード/検索語に関連するソリューションを検索することができます。これには "keyword "パラメータを使用します:
https://panorama.solutions/en/api/v1/solutions?keyword=marine
URLエンコードされたスペースで区切られたキーワードを追加することで、複数のキーワードを追加して検索を絞り込むことができます:
https://panorama.solutions/en/api/v1/solutions?keyword=marine%20fisheries
検索キーワードを含むAPIリクエストには、常に "search_api_relevance "値を持つソート・パラメータ "sort_by "を追加して、検索に関連性の高いソリューションを最初に取得する必要があります:
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 フィルタを使用します。
ID は、API をリクエストするか(ソリューション・オブジェクトの一部です)、ソリューションの HTML ソースコード(body タグを参照)を見て見つけることができます。
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コードによるソリューションのリクエスト
パラメータ&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