Top > GeoPlatformAPI > OrkneyWebRoutingServiceAPIユーザーズガイド

Orkney Web Routing Service API ユーザーズガイド

これは何 ?

2点の緯度経度情報から、その2点間の最短ルートを取得することができる API です。Google Maps などとマッシュアップすることで、最短経路を地図上に表示することが可能です。

API 呼び出し時に、

  • 開始地点の緯度経度情報
  • 終了地点の緯度経度情報

を指定すると、指定したフォーマットでレスポンスが帰ってきます。

リクエスト

パラメータを指定して以下の URI で API サーバに GET リクエストしてください.

http://api.cirius.co.jp/wrs/1.0.0/{PROVIDER}/{INPUT FORMAT}/shortest_path.{OUTPUT FORMAT}?&start={START POINT COORDINATES}&end={END POINT COORDINATES}&sridIn={SRID IN}&api_key={API KEY}

変数の解説

変数名意味備考例
PROVIDERデータプロバイダ道路データのプロバイダ。hcc か suuchi を指定してください。hcc の方が高精度ですが、首都圏しか利用できません。hcc サポート地域=緯度: 35.1 〜 36.0、経度: 138.875 〜 140.375hcc
INPUT FORMAT入力フォーマット入力フォーマット (‘gml’, ‘xml’, ‘geojson’, ‘lonlat’, ‘wkt’, ‘kml’)lonlat
OUTPUT FORMAT出力フォーマット出力フォーマット (‘gml’, ‘xml’, ‘geojson’, ‘lonlat’, ‘wkt’, ‘kml’)lonlat
START POINT COORDINATES開始点INPUT FORMAT で指定した形式で、x軸、y軸を指定します。lonlat の場合経度%20緯度の形式です139.62279796600342%2035.46496931958601
END POINT COORDINATES終了点INPUT FORMAT で指定した形式で、x軸、y軸を指定します。lonlat の場合経度%20緯度の形式です。139.63284015655518%2035.45832792260284
SRID IN入力データの地図投影法日本測地系の場合 4301、世界測地系の場合 4326 を指定してください。4326 (世界測地系の場合)
api_keyAPI キーAPI キー(こちらで取得します)ABCDEFGHIJlkjadsrelakdjfaea123345

※"suuchi"プロバイダの利用距離制限は 100km までです。100km を越えた場合、"416 Requested Range Not Satisfiable" のエラーコードが返却されます。

オプションで指定できるパラメータ

パラメータ名意味備考例
sridOut出力データの地図投影法省略した場合、フォーマットに応じて自動設定されます。4326 (kml の場合
request_idリクエストID特定のリクエストIDを指定できます。そのままアウトプットに出力されます。test

レスポンス

OUTPUT FORMAT で指定した形式でルート情報が返却されます。
例：

  0
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34

<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://earth.google.com/kml/2.1">
<Document>
  <name>WebRouting Service</name>
  <Style id="LineStyle">
    <LineStyle>
      <color>7f0000ff</color>
      <width>4</width>
    </LineStyle>
  </Style>
  <Placemark>
    <description>No+description+available</description>
    <name>Shortest Path</name>
    <styleUrl>#LineStyle</styleUrl>
    <MultiGeometry>
      <LineString>
        <coordinates>
139.61958855946,35.468228787167,0 139.619595726136,35.4682789666634,0 
        </coordinates>
      </LineString>
      <LineString>
        <coordinates>
139.61958855946,35.468228787167,0 139.619595726136,35.4682789666634,0 
        </coordinates>
      </LineString>
      <LineString>
        <coordinates>
139.619595726136,35.4682789666634,0 139.619790575482,35.4682511371476,0 139.620553014305,35.468167833362,0 
        </coordinates>
      </LineString>
〜(省略)〜
    </MultiGeometry>
  </Placemark>
</Document>
</kml>

HTTP ステータスコードについて

リクエストに対応して以下のレスポンスコードを返却します. 主なレスポンスコードを以下に示します.

レスポンスコード意味備考
200OKリクエストが正しいとき
401Unauthorized認証が正しくないとき
416Requested Range Not Satisfiableサーバが対応できる距離制限を越えたとき
500Internal Server Errorサーバエラー(フレームワークなど)
503Service Unavailableサービスが利用できないとき

利用制限について

現時点では明示的な利用制限は設けておりませんが、本 API は実験的なサ ービスとして提供しておりますので、あまりに負荷が高くなる場合にはア クセス制限を設けさせていただく可能性があります。ご了承ください。
また、"suuchi"プロバイダ利用時には、100km までしか利用ができません。
本 API は GeoFormAPI と同じ APIキーが利用できますが、GeoFormAPI とは別のア クセスカウントとなりますので、本サ ービスでの利用回数は GeoFormAPI への影響いたしません。

オークニー社が、同様のサ ービスの商用版を提供しています。商用/安定利用をお考えの方は、Orkneyルート検索APIサービス のご利用をご検討ください。