WebAPI とは

概要

WebAPI とは、地図画像やPOI情報等の地図に付随するデータを提供するためのインターフェースです。
下記のパッケージを用意しています。

・ WebAPI

WebAPI では、株式会社ゼンリンの地図データを利用しています。

通信方式

WebAPIはHTTPSで通信を行います。クライアントはインターネットに接続が可能で、かつHTTPS通信が可能である必要があります。
ご利用可能なポート番号は443番になります。

API実行方法

各APIマニュアルページ記載のURIに適切なパラメータを付加し、HTTPSリクエストを行うことでAPI実行結果を得ることができます。
付加するパラメータには認証用パラメータとAPI固有パラメータがあります。
認証用パラメータ仕様についてはこちらを確認してください
API固有パラメータ仕様については各APIマニュアルページを確認してください。

また、利用可能なHTTPメソッドおよびPOSTメソッド利用時に対応しているリクエストヘッダを以下に記載します。

HTTPメソッド	GET/POST
リクエストヘッダ	Content-Type:application/x-www-form-urlencoded

※リクエストヘッダ Content-Type:multipart/form-data には対応しておりません。

API実行結果

[ステータスコード]
APIを実行するとHTTPステータスコードの標準定義(RFC2616, RFC6585)に準拠したコードをレスポンスヘッダで返します。
4xx, 5xx はエラーであり、エラー内容に関するメッセージが返却されます。
WebAPI内で汎用的に使用されるステータスコードについては下記のとおりです。

HTTPステータスコード		内容
2xx	200	正常終了です。マニュアルに特別な記述がない限り 200 を返却します。
4xx	400	パラメータエラーです。リクエストURL、パラメータにお間違えがないかご確認ください。
	401	認証失敗によるエラーです。必要な認証資格が不足してる場合に返却されます。(Unauthorized)
	408	タイムアウトによるエラーです。 POSTにてリクエストデータの送信が規定の時間を超過した場合に返却されます。(Request Timeout)
	429	リクエスト流入抑制機能による、大量リクエスト検知時の制限エラーです。制限を超過した場合に返却されます。(Too Many Requests) 制限についてはこちらをご確認ください。
5xx	500 503	リクエスト内容に起因した処理中断、レスポンスサイズの上限（20MB）を超過、またはサーバ側で発生しているエラーです。繰り返し発生している場合、お問い合わせください。

[レスポンスボディ]
ステータスコードが正常終了( 2xx ) の場合、HTTPSレスポンスボディに結果を出力します。
API実行結果は文字コードUTF-8のJSON形式で表されます。
なお、JSONオブジェクト要素の順序については保証されていませんので、マニュアルの例と実際の結果は異なる場合があります。
また、構造を変更しない出力要素の追加は予告なく行われる事があります