フリープランAPI概要

概要

項目
API Endpoint api.ekispert.jp
SSL Support 対応
利用可能なポート 80(http), 443(https)
利用可能なHTTPメソッド GETのみ
利用可能なレスポンスデータフォーマット xml, json (一部png, bmp, jpg対応)

API一覧

探索

駅の情報

付加情報

路線の情報

会社の情報

APIの詳細な仕様

レスポンスヘッダのContent-Type

レスポンスヘッダのContent-Typeは、それぞれのフォーマットについて以下のように値が返されます。 jsonの場合は、リクエストヘッダのAcceptを考慮して返却値が下記のように変わります。 品質係数が設定されたヘッダ値が送られてきた場合、優先度高い順に上記処理にしたがって設定されます。

フォーマット Content-Type
xml application/xml;charset=utf-8
json application/json, application/* のみの場合 application/json;charset=utf-8
text/plain, text/* のみの場合 text/plain;charset=utf-8
* / * , 未指定の場合 text/plain;charset=utf-8

リクエストパラメータに日本語を指定する場合

リクエストパラメータに日本語が含まれる場合には、 日本語の部分をUTF8でURLエンコード(パーセントエンコード)してください。

GET /v1/xml/station?key=xxx&name=%93%8c%8b%9e

複数指定

各APIのリクエストパラメータの中には「複数指定可」としているものがあります。 そのパラメータを複数指定する場合は、値をコロン(:)区切りで記述してください。

code=22828:22741

jsonにおけるindexの扱い

XMLで要素別の順番を表している"index"属性は、json形式のレスポンスには含まれません。同名要素が同じ階層に複数存在する場合、jsonでは要素名でまとめた配列としてデータが返されます。 また、"xxxIndex"といったindex関連の値は、xmlのindexを基準にしています。 xmlのindexは1から始まりますが、jsonの配列は0から始まるため、 値にズレが生じます。jsonでindex関連の値を扱う際はご注意ください。

<Route>
  <Point index="1">
    <Station code="22828">
      <Name>東京</Name>
    </Station>
  </Point>
  <Line index="1">
    <Name>JR新幹線のぞみ</Name>
  </Line>
  <Point index="2">
    <Station code="25978">
      <Name>新大阪</Name>
    </Station>
  </Point>
  <Line index="2">
    <Name>JR東海道本線・西明石行</Name>
  </Line>
  <Point index="3">
    <Station code="25853">
      <Name>大阪</Name>
    </Station>
  </Point>
</Route>
"Route": {
  "Point": [
    {
      "Station": {
        "Name": "東京",
      }
    },
    {
      "Station": {
        "Name": "新大阪",
      }
    },
    {
      "Station": {
        "Name": "大阪",
      }
    }
  ],
  "Line": [
    {
      "Name": "JR新幹線のぞみ",
    },
    {
      "Name": "JR東海道本線・西明石行",
    }
  ],
}

jsonにおけるテキストノードの扱い

あるxmlの要素がテキストノードのみを持っている場合、 jsonではそのテキストノードの内容を該当の要素名の値として設定します。

<Type>train</Type>
{"Type": "train"}

テキストノードを持つxmlの要素が子要素や属性も持っている場合、 jsonではそのテキストノードの内容を"text"の値として設定します。

<Type detail="loccal">bus</Type>
{
  "Type": {
    "detail": "local",
    "text": "bus"
  }
}

エラー

「駅すぱあとWebサービス」APIのエラーは、HTTPプロトコルとしてのエラーとエラーレスポンスに含まれるメッセージで表現しています。内部エラーコードにつきましては、サポート時に利用する参考情報となります。

<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.x.x.x" engineVersion="xxxxxx_xxx">
  <Error code="内部エラーコード">
    <Message>エラーメッセージ</Message>
  </Error>  
</ResultSet>