ご利用の手引き

「駅すぱあと API」をご利用いただくまでの手順をご紹介します。

1. キーの発行

「駅すぱあと API」をご利用いただくには、識別用のアクセスキーを取得する必要があります。
アクセスキーは「駅すぱあと API スタンダードプラン」評価版お申し込みフォームからお申し込みいただけます。

Amazon.co.jpで購入頂いた方は、そのアクセスキーをご利用下さい。
Amazon.co.jpでの購入後のアクセスキーはこちらからご確認頂けます。

Attention!

アクセスキーの管理にご注意ください。
APIのリクエスト数での課金となりますので、不用意にインターネット上に公開しないようご注意ください。

2. アクセスキーの確認

キー発行完了の連絡が届いたら、以下のいずれかの方法で「駅すぱあと API」にアクセスできるか確認を行います。
ブラウザ等で「駅すぱあと API」のAPIにアクセスし、アクセスキーが正常に作動しているかご確認ください。

note

APIのエンドポイントはAPI概要に記載しております。

以下は、データバージョンのAPIを利用したリクエスト例です。

GET /v1/xml/dataversion?key=アクセスキーを入力してください

<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.26.0.0" engineVersion="201602_02a">
<Version create="20160202" createType="Edition" caption="知識ベース"/>
<Version create="20160202" createType="Edition" caption="鉄道時刻表"/>
<Version create="20160201" createType="Date" createComment="Now" caption="ＪＲ"/>
<Version create="20160125" createType="Date" createComment="Now" caption="私鉄"/>
<Version rangeTo="20160326" rangeFrom="20151201" create="20160201" createType="Edition" rangeCaption="有効期間" caption="航空時刻表"/>
<Version create="20160203" createType="Edition" caption="高速・連絡・深夜急行バス"/>
<Version create="20160201" createType="Edition" caption="船"/>
<Version create="20160101" createType="Date" createComment="Now" caption="得トクきっぷデータ"/>
<Version create="20150801" createType="HideDay" createComment="Now" caption="住所データ"/>
<Copyrights companyId="2" company="株式会社交通新聞社">交承 平成25年68号ＪＲデータの内容は、株式会社交通新聞社発行の「ＪＲ時刻表」2016年2月号に基づいています。この時刻データを無断で転載・複写し、又は紙媒体、電磁媒体その他いかなる媒体に加工することも禁じます。ＪＲバスデータの内容は、株式会社交通新聞社作成のデータ平成28年2月分に基づいています。この時刻データを無断転載・複写や電磁媒体等に加工することを禁じます。一部の内容は株式会社ヴァル研究所が自らの責任により加工を加えたものです。</Copyrights>
</ResultSet>

以下のように、レスポンスで403エラーが発生した場合は、アクセスキーまたはドメインが間違っている可能性があります。

<ResultSet apiVersion="1.27.0.0" engineVersion="">
<Error code="W403">
<Message>認証エラー</Message>
</Error>
</ResultSet>

アクセスキーが間違っている場合

発行したアクセスキーをご確認いただく場合は、弊社までご連絡（info@val.co.jp）ください。

ドメインが間違っている場合

弊社に登録されたドメイン（申込書記載のドメイン）は、「駅すぱあと API」を利用するアプリケーションのドメインと一致する必要があります。登録したドメインをご確認いただく場合は、弊社までご連絡（info@val.co.jp）ください。

localhostで開発を行いたい場合

localhostからアクセスした場合、localhostは登録ドメインと異なりますので、403エラーが発生し、利用できない状態になります。詳細は、弊社までご連絡（info@val.co.jp）ください。

「駅すぱあと API」を利用するドメインではなく、企業のネットワークのドメインを登録している場合

「駅すぱあと API」を利用するアプリケーションのドメインをご登録ください。

3. 開発を始める前に

開発を始める前に、利用上の注意を必ずご一読ください。また、「駅すぱあと API スタンダードプラン」評価版をご利用の方は、評価版の制限事項もご覧ください。

これで開発を行う準備が整いました。

APIの仕様一覧は、APIをご覧ください。開発の際には、駅すぱあと API Playground、API Tester、Tips、サンプルコードを参考にしてみてください。