hi, hikaru

『駅すぱあと』でお馴染みヴァル研究所で、テクニカルエバンジェリストとして働いている丸山が綴るブログです。

管理サイトの機能がAPIになったよ! #駅すぱあとwebサービス

こんにちは。 管理サイト『User Console β版』のリリースと共に、その中で使われている機能をAPIで利用できるようにしました! 当記事では、APIの概要、利用開始方法をまとめてみたいと思います。

駅すぱあとwebサービス とは

国内初の乗換案内ソフト駅すぱあとがもつ様々な情報をWebAPIで提供しているサービスです。 経路探索はもちろん、駅データや時刻表などの情報を取得できます。 無料で使えるフリープランを用意しており、企業にかぎらず個人でも利用できます。

0円から駅すぱあとの経路検索や路線情報を追加できるWebAPI「駅すぱあとWebサービス」 | 駅すぱあと API

新しいAPIがリリース

駅すぱあとwebサービス スタンダードプラン の利用者向けに、アクセス数を取得できるAPI『アクセス数API β版』と、駅すぱあとの改訂情報を扱うAPI『改訂情報API β版』をご用意しました!

アクセス数API β版 - 駅すぱあとWebサービス Documents 駅データ・路線検索のWebAPI

改訂情報API β版 - 駅すぱあとWebサービス Documents 駅データ・路線検索のWebAPI

こちらは、駅すぱあとwebサービス スタンダードプランをご利用のお客様なら無料でお使いいただけます。

例えば、

  • 課金テーブルの上限に到達する前にアラート通知
  • データの改訂情報をwebサイトに提示して、エンドユーザに必要な情報を届ける

そういったことがこのAPIでできるようになります!

API 利用開始方法

1. フォームにて利用申請

β版ということもあり、会員登録が自動化されていません(汗)。 管理サイトと同様、面倒臭いと思いますが、こちらのページにて利用申請を行ってください。

数日以内に、 キーシークレット がメールで送られます。

2. 試しに叩いてみる

キーシークレット が送られてきたら、早速APIを利用することができます! 実際にAPIが叩けるか、試してみましょう。

APIのリファレンスを開きます。

アクセス数API β版 リファレンス

改訂情報API β版 リファレンス

APIの仕様は、Swaggerというツールを用いて作成されています。 Swaggerでドキュメントを作成すると、APIの仕様を見ながらその場でAPIを試し叩きすることができます。

Swaggerについては、過去のポストでも登場しているので、よかったらこちらも読んでみてください。

駅すぱあとWebサービスのドキュメントサイトにSwaggerを適用してさらに使いやすく! - hi, hikaru

さて、せっかくAPIのドキュメントがSwaggerに対応しているので、SwaggerでAPIを叩いてみましょう。

Authorize をクリックし、中に記載された説明通りに値を入力して認証を通します。

f:id:hiiiiiiihikaru:20170926154924p:plain

改訂情報APIの /transport.json をGETしてみようと思います。 こちらは、 駅すぱあと のエンジンバージョンの一覧を取得するAPIです。駅すぱあとのエンジンバージョンは、駅すぱあと関連の全ての製品に共有で振られるバージョンで、駅すぱあとwebサービスのレスポンス ResultSet/engineVersionがそれに値します。 こちらのAPIはリクエストパラメータが不要なので、一番簡単に試せそうです。

画面上にある [Try it out] > [Execute] の順に、ボタンをクリックしていきます。

f:id:hiiiiiiihikaru:20170926164202p:plain

認証が通れされすれば、swagger上でレスポンスを確認することができます。 また、curlコマンドでのリクエスト方法も教えてくれます。

f:id:hiiiiiiihikaru:20170926164037p:plain

ご注意いただきたいこと

サービスは別物です

駅すぱあとwebサービス と、今回紹介したAPIは、エンドポイントレベルではなくドメインから異なる、全く別のAPIとなります。

サービス ドメイン
駅すぱあとwebサービス api.ekispert.jp
アクセス数API β版 api-usage.ekispert.jp
改訂情報API β版 api-releasenote.ekispert.jp

認証方法やAPIの仕様など、互換性のないものになっておりますので、「API繋がらないっ!!」と焦る前に、リファレスを一読されてからご利用いただくようにお願いします。

あくまでもβ版

今回、βでの提供となりますので、認証方法やその他諸々が互換性を保たない変更を行う可能性があります。ご了承ください。

終わりに

管理サイト『User Console β版』の中で表示されている情報は、今回紹介したAPIを使って情報を取得したものです。 それを、駅すぱあとwebサービスをご利用のユーザでも使えるように公開したものになります。

管理サイト同様、β版での提供となります。 使い方が分からない、こういうことがやりたいんだけど、それはできるの?など、ぜひフィードバックいただければと思います。

駅すぱあとwebサービス スタンダードプランをご利用のお客様なら無料でお使いいただけますので、ぜひ利用してみてください!