BODIK APIマニュアル

BODIK APIは、Swaggerというオンラインマニュアルを提供しています。
各APIの詳細はSwaggerでご確認ください。

SwaggerのURL

https://wapi.bodik.jp/docs

各データセットに関するAPIの主な構成

自治体標準オープンデータセットの各データセットに対して、２つのGETメソッドのエンドポイントを提供しています。

GET <apiname>/organization        データを公開する自治体の一覧を取得します。
GET <apiname>                     データを検索します。

apiname

自治体標準オープンデータセットの名前を指定します。

apiname	データセット名称
aed	AED設置箇所一覧
care_service	介護サービス事業所一覧
hospital	医療機関一覧
cultural_property	文化財一覧
tourism	観光施設一覧
event	イベント一覧
public_wireless_lan	公衆無線LANアクセスポイント
public_toilet	公衆トイレ一覧
public_facility	公共施設
fire_hydrant	消防水利施設一覧
evacuation_space	指定緊急避難場所一覧
population	地域・年齢別人口
preschool	子育て施設一覧
food_business_license	食品等営業許可
school_lunch	学校給食
school_districts	学校区

データを公開する自治体の一覧

自治体標準オープンデータセット別にデータを公開している自治体一覧を取得します。

エンドポイント

    GET  /<apiname>/organization

Swaggerの例

リクエストURL

    GET https://wapi.bodik.jp/<apiname>/organization

レスポンス

以下の情報を含むJSONの配列を返します。

dataset_type    APIの種類を表す文字列
                    standard: 推奨データセット
                    msds: 自治体標準オープンデータセット
                    predefined: BODIKが定義した共通データセット
                    onecity: 自治体固有のデータセット
apiname         データセットの名前
organ_code      自治体コード
count           レコード件数

レスポンスの例

データの検索

自治体標準オープンデータセットのデータを検索します。

エンドポイント

    GET /<apiname>

Swaggerの例

リクエストURL

    GET https://wapi.bodik.jp/<apiname>

パラメータ

APIのパラメータは、リクエストURLの後ろに「?」をつけて、クエリパラメータとして指定します。

パラメータの例

https://wapi.bodik.jp/aed?select_type=data&maxResults=10&municipalityName=福岡市

レスポンス

各データセットごとに、データセットのレコードを記述したJSONデータを返します。詳細はSwaggerをご確認ください。

レスポンスの例

その他のAPI

POSTメソッド

次の２つの目的でPOSTメソッドを使用します。

• すこし高度な検索をする。
  • 数値項目に対して、範囲を指定して検索する。
• 「自治体標準オープンデータセット」ではないデータセットのデータを検索する。
  • 次のようなAPIは、事前にGETメソッドを用意できないのでPOSTメソッドで利用してください。
    • BODIKが定義した共通データセット
    • 自治体固有のデータセット
    • お試しのMyAPI
  • 自治体標準オープンデータセットをPOSTメソッドで利用することもできます。

エンドポイント

    POST /api/<apiname>

Swaggerの例

リクエストURL

    POST https://wapi.bodik.jp/api/<apiname>

パラメータ

APIのパラメータをJSON形式の「リクエストボディ」として指定します。
例えば、数値項目の範囲を指定したいとき、POSTメソッドのリクエストボディを使って条件を指定し、検索することができます。

詳細は、BODIK APIサンプルアプリケーションの「API検索（POSTメソッド版）」をご確認ください。

パラメータの例

{
	"maxOccupancyCapacity" : {		// 収容人数が
		"gte": 1000,			// 1000以上
		"lte": 2000,			// 2000以下
	}
}

API検索（POSTメソッド版）

    URL：https://wapi.bodik.jp/apisearch_post

レスポンス

GETメソッドのエンドポイントと同じように、検索結果を記述したJSONデータを返します。

レスポンスの例

データセットの構成情報

データセットの構成情報を知ることができます。

エンドポイント

    GET /config/<apiname>

Swaggerの例

リクエストURL

    GET https://wapi.bodik.jp/config/<apiname>

レスポンス

次のようなデータセットの構成情報をJSONデータとして取得します。

apiname              データセットの名前
index                DB上のインデックス名
display_name         データセットの表示名
geometry             地理情報の形式
dataModel            自治体標準データセットの項目情報

# クロール用の設定
must_fields          必須項目
tag_only             タグ優先指定
select_latest        Trueの場合、最新ファイルだけを採用する。
dataset_title_list   データセット名にこの文字列が含まれているものを採用する。
tag_list             このタグが指定されているデータセットを採用する。
resource_title       リソースタイトル
resource_filename    リソースファイル名
format_list          リソースのファイル形式

# その他
fields               DBのフィールド情報
mapping              DBのインデックス情報

レスポンスの例

自治体情報

BODIK ODMにオープンデータを公開している自治体情報を取得します。

エンドポイント

    GET /organization

Swaggerの例

リクエストURL

    GET https://wapi.bodik.jp/organization

レスポンス

自治体情報のJSONの配列で取得します。

organ_code   自治体コード
organ_name   自治体名称

レスポンスの例