利用ガイド

2016.06.16 初版作成

本APIにて提供するデータ形式について説明します。

目次

JSON API

概要

広く普及したデータ交換形式であるJSON形式でデータを提供するAPIです。
属性や位置による検索に対応しており、アプリケーションに組み込んで利用することで、たとえば検索したデータを一覧表示したり、地図上でデータを可視化することができます。

基本的なリクエストは、次のような形式になります。

https://{オープンデータサーバ}/opendataapi/servicepoint/{サービスポイント名}?auth_key={あなたの認証キー}

サービスポイント名は取得したいデータの種類を表す文字列であり、公開リソース一覧から選択します。 認証キーについては次節で説明します。

たとえば、次の例は、災害情報を取得する場合です。

https://{オープンデータサーバ}/opendataapi/servicepoint/disaster?auth_key={あなたの認証キー}

これで次のような災害情報の一覧が取得できます。

{
  "type": "FeatureCollection",
  "features": [
    {
      "id": 40,
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          138.375839233,
          35.00938797
        ]
      },
      "properties": {
        "disaster_name": "平成26年台風18号",
        "open_flag": "0",
        "spot": "静岡市葵区松富２丁目７−３５",
        "spot_public": "静岡市葵区松富２丁目７−３５",
        "road_name": "松富上１号線",
        "reasons": [
          {
            "type": "災害",
            "reason": "災害等",
            "reason_detail": "倒木"
          },
          ...
        ],
        ...
      }
    },
    ...
  ]
}