ご利用の手引き

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

1. キーの発行

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

note

アクセスキーの発行前にAPIを試したい方はAPI Testerをご利用ください。
フリープランのAPI Testerはアクセスキー無しでお試しいただけます。

2. アクセスキーの確認

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

note

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

以下は、駅簡易情報のAPIを利用したリクエスト例です。

GET /v1/xml/station/light?key=アクセスキーを入力してください&name=東京

<?xml version="1.0" encoding="UTF-8" standalone='yes'?>
<ResultSet apiVersion="1.27.0.0" engineVersion="201612_02a">
    <Point>
        <Station code="22828">
            <Name>東京</Name>
            <Type>train</Type>
            <Yomi>とうきょう</Yomi>
        </Station>
        <Prefecture code="13">
            <Name>東京都</Name>
        </Prefecture>
    </Point>
    <Point>
        <Station code="29110">
            <Name>成田空港(東京)</Name>
            <Type>plane</Type>
            <Yomi>なりたくうこう</Yomi>
        </Station>
        <Prefecture code="12">
            <Name>千葉県</Name>
        </Prefecture>
    </Point>
    <Point>
        <Station code="22827">
            <Name>羽田空港(東京)</Name>
            <Type>plane</Type>
            <Yomi>はねだくうこう</Yomi>
        </Station>
        <Prefecture code="13">
            <Name>東京都</Name>
        </Prefecture>
    </Point>
    <Point>
      :
    </Point>
</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エラーが発生し、利用できない状態になります。localhostからアクセスしたい場合は、info@val.co.jp までご相談ください。

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

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

3. 開発を始める前に

開発を始める前に、利用上の注意を必ずご一読ください。これで開発を行う準備が整いました。

APIの仕様一覧は、API概要をご覧ください。

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

4. フリープランで物足りないと感じたら

「駅すぱあと API」では、「経路探索」や「情報編集」、「範囲探索」を含むすべてのAPIをご利用いただける、「駅すぱあと API スタンダードプラン」も提供しております。詳細はドキュメントサイトをご一読ください。
フリープランとスタンダードプランの比較表はこちら。