ご利用の手引き

「mixway API」を使用する際の流れや、参考資料・ツールをご紹介します。

APIのアクセスキーを入手する

「mixway API」をご利用いただくには、アクセスキーが必要です。アクセスキーは、以下のフォームからお申し込みいただけます。お申し込みいただいた3営業日以内に、メールにてお客様専用のアクセスキーをお送りいたします。

アクセスキーは、届いたその日からご利用いただけます。正常にアクセスできるか、以下のようなブラウザからのアクセスや、後述の「経路探索の可視化ツール」にてお確かめください。

なお、「mixway API」で利用できるシェアサイクルなどの交通データ利用時には、手続きが発生する場合があります。

リクエスト例

GET https://mixway.ekispert.jp/v1/json/dataversion?key=[アクセスキー]

※データのバージョン情報を取得

レスポンス例

{
  "ResultSet": {
    "apiVersion": "1.27.0.0",
    "engineVersion": "202105_06a",
    "Version": [
      {
        "create": "20210504",
        "createType": "Edition",
        "caption": "知識ベース"
      },
      〜中略〜
      {
        "create": "20210101",
        "createType": "HideDay",
        "createComment": "Now",
        "caption": "住所データ"
      }
    ],
    "Copyrights": {
      "text": "交承 平成25年68号\nＪＲデータの内容は、株式会社交通新聞社発行の「ＪＲ時刻表」2021年5月号に基づいています。〜中略〜ほか、一部の内容は株式会社ヴァル研究所が自らの責任により加工したものです。\n",
      "companyId": "2",
      "company": "株式会社交通新聞社"
    }
  }
}

レスポンスが以下のような認証エラーの場合、アクセスキーが間違えている可能性があります。
入力し直しても解消されない場合、「mixway API」お問い合わせ窓口へお問い合わせください。

{
  "ResultSet": {
    "Error": {
      "code": "W403",
      "Message": "認証エラー"
    }
  }
}

お問い合わせフォームはこちら
（E-MAIL: maas-sales@val.co.jp ）

APIの仕様を確認する

「mixway API」は、「駅すぱあと」のAPIサービスである「駅すぱあと API」と互換性を持つAPIサービスです。類似の機能を有しており、両方に同名の機能が存在する場合があります(例: 経路探索API /v1/json/search/course/extreme）。
機能によっては相違点があるため、各機能のページよりご確認ください。

また、本ドキュメントとあわせて、「駅すぱあと API」のドキュメントもご参照ください。

駅すぱあと APIのドキュメントはこちら
用語・単語の説明はこちら
「mixway API」と「駅すぱあと API」の特に注意が必要な相違点
- API Endpoint
  - 「mixway API」のAPI Endpointはmixway.ekispert.jpです。
- レスポンスデータフォーマット
  - 「mixway API」はjsonにのみ対応しています。xmlは非対応です。
- 経路シリアライズデータ
  - 「mixway API」が返す経路シリアライズデータと、「駅すぱあと API」が返す経路シリアライズデータに互換性はありません。「mixway API」から得られた経路シリアライズデータ(「mixway形式経路シリアライズ」とも表記）は「mixway API」にパラメータで渡すことは出来ても、「駅すぱあと API」に渡すとエラーになります。逆もまた真です。
- 測地系
  - 「mixway API」は一部、世界測地系(wgs84)にしか対応していないAPIがあります。常に世界測地系を使うことを推奨します。

お役立ち：可視化ツールを使う

経路探索のAPI /search/course/extreme、経路探索のシェイプ情報のAPI /course/shape の結果を可視化するツールを公開しています。ツール上にアクセスキーとリクエスト内容を貼り付けると、ブラウザ上にリクエストした経路探索結果を表示します。

例：東京タワー発→代々木公園着の可視化

URLでのリクエスト例

https://mixway.ekispert.jp/v1/json/search/course/extreme?key=[アクセスキー]&viaList=35.6585805,139.7454329:35.6715869,139.6967028

ツールでの探索結果例

APIのアクセスキーを入手する​

リクエスト例​

レスポンス例​

APIの仕様を確認する​

お役立ち：可視化ツールを使う​

例：東京タワー発→代々木公園着の可視化​