Edited at

アクセスキー要らず!!API Testerで 駅すぱあとWebサービスに簡単入門する

ヴァル研究所アドベントカレンダー2018の5日目です。

EWS_mini.png

経路探索サービス「駅すぱあと」の持つ機能や情報をWebAPIで利用できるサービス「駅すぱあとWebサービス」に、簡単に入門できる便利なツールをご紹介します。


駅すぱあとWebサービスってなに?

「駅すぱあとWebサービス」は、経路探索サービス「駅すぱあと」の持つ機能や情報をWebAPIで利用できるサービスです。

経路探索はもちろん、以下のような機能を簡単に使うことができます。


  • 条件を指定した経路探索

  • 定期券関連の機能(「定期券を使ったら運賃はXX円」みたいな)

  • 範囲探索(「◯◯駅からX分の駅」みたいな)

  • 駅や路線の情報の取得(名称、位置、路線など)

  • 時刻表の取得

  • 鉄道運行情報の取得
    などなど

なんでもござれです。

もっと知りたい方はこちらから


簡単に使ってみよう

駅すぱあとWebサービスを使うには


  • 無料で一部の機能が使えるフリープラン

  • より便利な機能をお手軽に使えるSaaSストアプラン→こちら

  • 全ての機能を使えるスタンダードプラン

などいくつかの方法があります。

ここではフリープランから無料で使える2つの機能を試してみましょう。

APIの利用にはキーが必要ですので、こちらからお申し込みください。数営業日以内にキーをお送りします。

「えーキー発行がめんどくさい」と思ったそこのあなた!!

フリープランのドキュメントサイトAPI Testerというツールがあります。このツールではGUIでパラメータを指定し、駅すぱあとWebサービス フリープランのリクエストとレスポンスを確認することができます。しかもキーなしで試すことができます!!

まずはAPI Testerでどんなレスポンスを返すのか確認し、使いたくなったら各プランに申し込んでいただくのが良いでしょう。


キー要らずで駅すぱあとWebサービスを試してみる


駅情報機能

まずは駅情報機能 /station を使ってみましょう。

こちらが駅情報機能のAPI Testerです。

スクリーンショット 2018-12-04 20.46.57.png

図に示したようにformatパラメータにはjsonを、nameパラメータには東京を指定します。そして画面を下へスクロールし「Try it Out!」のボタンをクリックしましょう!!

すると下に色々と情報が出てきます。

api_tester_02.png

Request URLには実際に駅すぱあとWebサービスへ投げたリクエストが入っています。

(実際にブラウザ等から投げたい場合は先述の方法でAPIキーを取得してください)

http://api.ekispert.jp/v1/json/station?name=%E6%9D%B1%E4%BA%AC&offset=1&limit=100&direction=up&gcs=tokyo&key={ご自身のアクセスキーを入力してください}

Response Bodyには実際に帰ってきたレスポンスが入っています。

例えば$.ResultSet.max要素を見れば「東京」で始まる駅が全国に7つあることがわかります。

また$.ResultSet.Point[0].GeoPoint要素には東京駅の位置情報が入っています。

こんな感じで簡単に駅の情報を取得することができました。

ここで紹介した以外のリクエスト/レスポンスパラメータはドキュメントページをぜひご覧ください。

以前、この駅情報機能を使って、Vue.jsで駅名インクリメンタルサーチを作るという記事を書いたことがあります。こちらもよろしければどうぞ:grin:

駅名のインクリメンタルサーチができる検索窓をVue.jsで作る


駅すぱあと for web URL生成機能

続いては駅すぱあと for web で経路探索結果を表示するためのURLを生成する機能を使ってみましょう。このURLへのリンクを皆さんのサイトやサービスに貼ってもらうと、「経路はこちらから!」のように「駅すぱあと for web」の結果画面へ簡単に案内することができます!

では例によってAPI Tester

スクリーンショット 2018-12-04 21.07.06.png

ここではformatパラメータにjson、fromとtoのパラメータにそれぞれ高円寺駅と東京駅の駅コード2267122828を指定します。

駅コードではなく駅の名称(「東京」「高円寺」のような)でもリクエストできます。しかし駅すぱあとWebサービスでは、駅をより一意に定めるため駅コードの利用を推奨しています。

(駅コードは先ほどの駅情報機能のレスポンスの$.ResultSet.Point[0].Station.codeから取得できます!!)

これで再度「Try it Out!」

スクリーンショット 2018-12-04 21.07.20.png

Response Bodyに入ったJSONの$.ResultSet.ResourceURI になにやら長いアドレスが返って来ました。ブラウザのアドレスバーに入れてみましょう。

スクリーンショット 2018-12-05 15.50.39.png

確かに高円寺駅から東京駅を経路探索した結果をみることができていますね!!


まとめ

ということでアクセスキー不要で駅すぱあとWebサービスを試すことができるAPI Testerをご紹介しました。

こちらとフリープランの機能スタンダードプランの機能を見比べ、駅すぱあとWebサービスがどのようなサービスなのか知ってください!!

そしてもし気に入ったらまずはフリープランのアクセスキーをゲットしましょう!!