フリープランAPI概要

概要

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

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

複数指定

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

code=22828:22741

また、コロン:は、URLエンコード(パーセントエンコード)せずに指定してください。

エラー

「駅すぱあと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>

HTTPステータスコード

「駅すぱあとWebサービス」では下記のHTTPステータスコードを返します。
エラーの判断にご利用ください。

HTTPステータスコード 説明
200 OK. エラーではありません。
リクエストが成功し、要求に応じたレスポンスが返されます。
400 Bad Request. エラーです。
送信されたパラメータに誤りがある場合に返されます。
403 Forbidden. エラーです。
認証できなかったか、利用できない機能を呼び出した場合などに返されます。
※ 詳しくはアクセスキーの確認をご確認ください。
404 Not Found. エラーです。
指定されたパスが存在しなかった場合に返されます。
500 Internal Error. エラーです。
API自身のエラーによって処理の続行ができない場合などに返されます。

API一覧

探索

駅の情報

付加情報

路線の情報

会社の情報