SaaSストアで駅すぱあとWebサービスを購入する

ヴァル研究所 Advent Calendar 2018 3日目の記事です。
今日はAmazon SaaSストアで駅すぱあとWebサービスが購入できるよという話と、簡単な利用例を紹介します。

SaaSストアで駅すぱあとWebサービスを購入する

駅すぱあとWebサービスの利用にあたりアクセスキー(APIキー)が必要になりますが、個人でアクセスキーの発行を申し込もうとすると費用等がネックになることがあります。無償版での利用も可能ですが、使用できるAPIの種類が限られているのでバリバリ使おうとする場合は物足りなく感じることもあります。

Amazon SaaSストアでの駅すぱあとWebサービスはそういった個人ユーザや中小企業での利用・試用を想定したプランとなっています。

• 2018年05月29日 Amazon SaaSストアで経路検索API「駅すぱあとWebサービス」を販売開始

SaaSストアで購入できる駅すぱあとWebサービスは、個人ユーザにも利用できる手ごろな価格でサービスを提供しており、リクエスト数(APIの呼び出し回数)毎に料金ラインナップが用意されています。

• 5,000リクエスト(5,400円)
• 10,000リクエスト(10,800円)
• 20,000リクエスト(21,600円)

購入方法については利用開始ガイド(PDF)をご参照ください。

利用可能なWebAPIの種類

ダイヤデータ等を含むWebAPIは除かれていますが、無償版よりも多くの機能が利用できるようになっています。

• 範囲探索
• 範囲探索(旧版)
• 平均待ち時間探索
• 駅情報
• 駅簡易情報
• 緯度経度からの周辺駅検索
• 住所情報からの周辺駅検索
• 通過駅情報
• 駅付加情報
• 運行路線情報
• 会社情報
• 地点生成
• 測地系変換
• 定期券の払い戻し計算
• 定期代の分割計算
• 運賃の分割計算
• 探索結果の運賃切り替え
• 航空路線時刻表
• 航海路線時刻表
• 回数券一覧
• 回数券詳細
• 路線図一覧
• 路線図画像
• 路線図駅情報
• データバージョン

さっそく使ってみる

駅すぱあとWebサービスのアクセスキーを購入したら、さっそくWebAPIが呼び出せるか試してみましょう。
利用開始ガイド(PDF)にもありますが、データバージョンAPIを呼び出せるかどうかで確認するのが早道です。

http://api.ekispert.jp/v1/xml/dataversion?key=アクセスキーを入力してください

URLやアクセスキーの指定に問題がなければ、以下のようなレスポンスが取得できます。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResultSet apiVersion="1.27.0.0" engineVersion="201812_01a">
  <Version create="20181201" createType="Edition" caption="知識ベース"/>
  <Version create="20181201" createType="Edition" caption="鉄道時刻表"/>
  <Version create="20181201" createType="Date" createComment="Now" caption="ＪＲ"/>
  <Version create="20181119" createType="Date" createComment="Now" caption="私鉄"/>
  <Version rangeTo="20190107" rangeFrom="20181001" create="20181202" createType="Edition" rangeCaption="有効期間" caption="航空時 刻表"/>
  <Version create="20181202" createType="Edition" caption="高速・連絡・深夜急行バス"/>
  <Version create="20181201" createType="Edition" caption="船"/>
  <Version create="20181101" createType="Date" createComment="Now" caption="得トクきっぷデータ"/>
  <Version create="20180801" createType="HideDay" createComment="Now" caption="住所データ"/>
  <Copyrights companyId="2" company="株式会社交通新聞社">交承 平成25年68号
ＪＲデータの内容は、株式会社交通新聞社発行の「ＪＲ時刻表」2018年12月号に基づいています。
この時刻データを無断で転載・複写し、又は紙媒体、電磁媒体その他いかなる媒体に加工することも禁じます。

ＪＲバスデータの内容は、株式会社交通新聞社作成のデータ平成30年11月分に基づいています。この時刻データを無断転載・複写や電磁媒体等に加工することを禁じます。

名鉄バスの情報は、名鉄バス株式会社作成のデータに基づいています。ただし一部のバス停ポール情報は株式会社ヴァル研究所が自らの責任により加工したものです。

ほか、一部の内容は株式会社ヴァル研究所が自らの責任により加工したものです。
</Copyrights>
</ResultSet>

簡単なサンプルを動かしてみる

データバージョンAPIでレスポンスが取得できることを確認したら、次は簡単なサンプルを動かしてみましょう。

サンプルコードはGitHubに置いてあります。

• ValLaboratory/advcal

DockerとDocker Composeで環境を構築していますので、上記のリポジトリをcloneしたのち、以下の手順でDockerイメージをビルドします。

$ # GitHubからcloneして作業ディレクトリに移動する。
$ git clone https://github.com/ValLaboratory/advcal.git
$ cd advcal/2018/docker_env
$
$ # Dockerイメージをビルドする。
$ docker-compose build hello_ews

ビルドが完了したら、コンテナを起動します。

$ docker-compose up hello_ews

HTML/JavaScriptはコンテナ側からローカルのディレクトリを参照しています。JavaScriptファイル( advcal/2018/docker_env/public_html/hello_ews/app.js )の以下の箇所を、駅すぱあとWebサービスのアクセスキーで置き換えます。

APP = (function() {
    var ACCESS_KEY = 'ここにアクセスキーを入力';

以下のURLにアクセスすると、簡単なサンプルアプリを表示できます。

• http://localhost:8080

今回のサンプルでは駅付加情報APIを呼び出しています。駅コード 22828 (東京駅)の福祉施設情報が取得できています。
(駅コードについては、以前の記事をご参照ください)

まとめ

SaaSストアで駅すぱあとWebサービスが購入可能になった話と、簡単なサンプルを動かしてみる例を紹介しました。

SaaSストアで提供されるプランでは、利用できるAPIが無償版よりも多いので、より駅すぱあとWebサービスの機能を活用できるかと思います。
また、今回のサンプルはごく簡単なものでしたが、利用できるAPIが増えると駅すぱあとWebサービス HTML5インターフェースサンプルを活用したくなってきます。

明日の記事では、この駅すぱあとWebサービス HTML5インターフェースサンプルを用いた開発環境の準備方法を紹介できればと思います。