HERE Geocoding and Search API v7へのリクエストの作成
HERE Geocoding and Search API v7へのリクエストには次の表に示す基本要素が含まれます。
また、リソース固有のパラメーターを含めることができます。
GETリクエスト
情報
ほとんどのHERE Geocoding and SearchエンドポイントはGETメソッドで呼び出します。
| 要素 | 値/例 | 説明 |
|---|---|---|
| メソッド | GET |
|
| スキーム | https |
|
| ベース URL |
[service].search.hereapi.com
|
選択したサービスのベースURL。エンドポイントは関連するサービスに基づいて名前が付けられています。
たとえば、Discoverサービスは/discoverエンドポイントによって提供されるため、
ベースURLはdiscover.search.hereapi.comです。
|
| バージョン | v1 |
|
| エンドポイント | /discover |
自由形式のテキスト クエリを使用して場所または位置を検索する |
/autosuggest |
検索クエリ作成時に候補を取得する | |
/geocode |
住所を検索し、対応する地理座標を返す | |
/autocomplete |
入力したキーストロークのアドレス補完を取得する | |
/revgeocode |
特定の地理座標に最も近い住所を検索する | |
/browse |
名前または{'}を使用して場所を検索する category IDs | |
/lookup |
IDを使用して場所または位置オブジェクトを検索する | |
| パラメーター | [key]=[value]&... |
エンドポイント固有のクエリパラメーター。 同じパラメーターキーを繰り返すと、 400エラーになります。詳細については、「APIリファレンス」を参照してください。 |
URIの例:
https://discover.search.hereapi.com/v1/discover?at=52.5228,13.4124&q=petrol+station&limit=5
次のパラメーターを使用して\discoverエンドポイントを呼び出しています。
atを緯度52.5228と経度13.4124に設定qを「petrol station」に設定limitを 5 に設定
POSTリクエスト
| 要素 | 値 | 説明 |
|---|---|---|
| メソッド | POST |
|
| スキーム | https |
|
| ベース URL |
[service].search.hereapi.comChina: signals.search.hereapi.cn
|
選択したサービスのベースURL。エンドポイントは関連するサービスに基づいて名前が付けられています。
たとえば、Multi-Reverse Geocodeサービスは、
/multi-revgeocode
エンドポイントによって提供されます。したがって、Multi-Reverse GeocodeサービスのベースURLは
multi-revgeocode.search.hereapi.comです。
|
| バージョン | v1 |
|
| エンドポイント | /multi-revgeocode |
1回のリクエストで複数の住所または場所を取得する |
| パラメーター | [key]=[value]&... |
エンドポイント固有のクエリパラメーター。 同じパラメーターキーを繰り返すと、 400エラーになります。詳細については、「APIリファレンス」を参照してください。 |
| ボディ | [key]=[value]&... |
POSTボディ固有のパラメーター。 同じパラメーターキーを繰り返すと、 400エラーになります。詳細については、「APIリファレンス」を参照してください。 |
| 要素 | 値 | 説明 |
|---|---|---|
| メソッド | POST |
|
| スキーム | https |
|
| ベース URL |
signals.search.hereapi.comChina: signals.search.hereapi.cn
|
ベースURL |
| バージョン | v1 |
|
| エンドポイント | /signals |
結果項目に対するユーザーアクションについて情報を共有する |
リクエストヘッダー
重要なコンテキスト情報は、HTTP リクエスト ヘッダーを任意で使用して API に渡されます。適用可能な場合、サービスは確立され標準化されたヘッダーを利用し、追加のプライベート ヘッダーを使って補完します。このようなヘッダーには結果に直接影響するものもあれば、検索結果の最適化に役立つものもあります。
次の表は http リクエスト ヘッダーの説明をまとめたものです。
| ヘッダー名 | 説明 |
|---|---|
| Accept | レスポンスの Accept ヘッダー仕様に使用できるメディア タイプを指定します。サポートされている値は application/json のみで、標準の JSON レスポンスが返されます。この値はデフォルト値でもあります。 |
| Date | ユーザーの現地時間。例:「Mon, 08 Aug 2011 11:58:17 GMT」(日付ヘッダー仕様を参照してください)。 |
| User-Agent | クライアントユーザーエージェントを識別する文字列(「User-Agentヘッダー仕様」を参照してください)。統計目的で使用されます。HERE Geocoding and SearchにWebブラウザー内からアクセスした場合、ブラウザーはこの情報を自動的に送信します。他のアプリケーションでは、アプリケーションで明示的に設定する必要がある場合があります。 |
| Accept-Encoding | クライアントはレスポンスの圧縮転送機能を有効にできます。サポートされている値はgzip-compressionのみです。このオプションを使用することを強くお勧めします。クライアントアプリケーションの応答性とパフォーマンスに大きく影響します(「Accept-Encodingヘッダー仕様」を参照してください)。 |
| X-Request-ID | クライアントはHERE Geocoding and Searchに送信するクエリごとに異なるIDを指定でき、そのIDをレスポンスヘッダーで取得できます。これはリクエストに対するレスポンスの相関関係について、お客様独自のデータマイニングとログ分析を行い、潜在的な問題についてHEREとやりとりするうえで役に立ちます。 |
レスポンスのカスタマイズ
HERE Geocoding and Searchでは、showクエリパラメーターを使用することでレスポンスをカスタマイズできます。詳細については、それに関する章を参照してください。
4 日前の更新