全国道路施設データベース

トンネル DB

データ取得・閲覧 API 仕様書

Ver 1.30

令和６年９月４日

一般社団法人 日本建設機械施工協会
施工技術総合研究所

目次

目次.......................................................................................................................... - 2 1. 本仕様書の概要 ................................................................................................... - 2 2. API 接続方式 ........................................................................................................ - 4 2.1. 通信プロトコル .................................................................................................................. - 4 2.2. REST 対応 ........................................................................................................................... - 4 2.3. エンドポイント一覧 （バージョン１） .......................................................................... - 4 2.4. 文字コード.......................................................................................................................... - 4 2.5. リクエスト.......................................................................................................................... - 4 2.5.1. データ参照 API ............................................................................................................ - 4 2.5.2. ファイル取得 API ........................................................................................................ - 4 2.6. レスポンス.......................................................................................................................... - 4 2.6.1. データ形式 ................................................................................................................... - 4 2.6.2. ファイル出力 ............................................................................................................... - 5 2.7. エラーレスポンス............................................................................................................... - 6 2.8. API のパラメータ ................................................................................................................ - 7 2.9. トンネル簡易検索............................................................................................................... - 7 2.1. 最新トンネル検索............................................................................................................... - 8 2.1. 詳細検索 ............................................................................................................................. - 8 2.2. ファイル取得 API ............................................................................................................. - 11 2.2.1. 点検報告書様式ファイル取得 API ............................................................................. - 11 2.2.2. 付属ファイルリスト取得 API .................................................................................... - 11 2.2.3. 付属ファイル取得 API ............................................................................................... - 12 2.2.4. イメージファイル取得 API ........................................................................................ - 12 2.2.5. 台帳 PDF 取得 API ..................................................................................................... - 12 2.3. 日付表記 ........................................................................................................................... - 13 2.4. API 認証 ............................................................................................................................. - 13 2.5. 詳細検索パラメータ ......................................................................................................... - 13 -1. 本仕様書の概要
本仕様書は、「全国道路施設データベーストンネル」のオンラインで提供する諸元や点検データ等をデータ参照するための API に関する仕様書です。

-2-

更新履歴
Ver1.00

新規作成

Ver1.10 2023/08/16

イメージファイル取得 API 追加

Ver1.20 2023/09/20

台帳 PDF 取得 API 追加
トンネル図面類を出力するかのフラグ追加（zumen）
空欄理由出力機能追加(blank_flg)

Ver1.30 2024/09/04

変状・異常箇所写真位置図を出力するかのフラグ追加
全体変状展開図を出力するかのフラグ追加
全体変状展開図(機器活用時)を出力するかのフラグ追加
スパン別変状詳細展開図を出力するかのフラグ追加
健全性の診断の区分の所見を出力するかのフラグ追加-3-2. API 接続方式
2.1. 通信プロトコル
セキュアな HTTP プロトコルである HTTPS によって通信を行う。API を設置するサーバはTLS(SSL)対応を必須とする。
2.2. REST 対応
本 API のデータ参照様式は、REST（記述方式）に則った仕様を基本とする。
2.3. エンドポイント一覧 （バージョン１）○○/xROAD/api/v1/tunnels?検索条件

施設データ簡易参照○○/xROAD/api/v1/tunnels/lastest?検索条件

最新施設データ簡易参照○○/xROAD/api/v1/tunnels/search?検索条件

施設データ高度参照○○/report77/{施設 ID}/{年度}

点検報告書様式ファイル取得○○/xROAD/api/v1/tunnels/otherFileList?{検索条件}

付属ファイルリスト取得○○/xROAD/api/v1/tunnels/otherFile/{ファイル ID}

付属ファイル取得○○/xROAD/api/v1/tunnels/imageFile/{ファイル ID}

イメージファイル取得○○/xROAD/api/v1/tunnels/daicho/{施設 ID }台帳 PDF 取得※○○は「https:// road-structures-db-tunnel.mlit.go.jp」
2.4. 文字コード
本 API を利用した通信上で、日本語を扱う場合は、文字コードは UTF-8 とする。
2.5. リクエスト
2.5.1. データ参照 API
REST の仕様に則って、GET メソッドを用いてデータの参照を行う。
一部の API はデータ量の上限回避のため POST メソッドを用いる。
2.5.2. ファイル取得 API
GET メソッドを用いて API にアクセスし、ファイルのダウンロードを行う。
2.6. レスポンス
2.6.1. データ形式
ファイル以外は、JSON 形式の文字列として以下の形式で返す。
metadata
API の内容やリクエスト情報など
resultset
検索結果の件数や 1 ページのデータ数など
result参照に成功した場合は参照したデータを、失敗した場合はエラーの内容を含んだ処理結果-4-を返す。

No.

区分

パラメータ名必須

1

metadata

title

○

内容
データの内容を示すタイトル

2

detail3

parameter◯

リクエスト時に渡されたパラメータ

is_error◯

処理にエラーがある場合は true。ない場合は

4

resultset

データの内容説明

false
5error_title

エラーのタイトル。is_error が true の場合は必須

6error_detail

エラーの詳細7

count対象データの件数

8

limit

一度に参照するデータ数の上限

9offsetデータ参照開始位置

10result─

結果データ

レスポンス例）{"metadata":{"title": "トンネルデータ一覧","detail": "トンネルデータ一覧","parameter": {"area": "35.35,35.44,139.35,139.46"}},"resultset":{“is_error”: false,"limit": 25,"offset": 0,"count": 4},"result":{(トンネルデータ一覧)}

2.6.2. ファイル出力
バイナリ形式のファイルは、HTTP の仕様(RFC6266)に準じて、ファイルの種類に合ったレス-5-

ポンスヘッダを出力した上で、続けてバイナリデータを送信する。
2.7. エラーレスポンス
処理中に致命的なエラーが発生した場合、適切な HTTP レスポンスコードとエラー内容をJSON 形式で返す。
No.

レスポンスコ

内容ード
1400

リクエスト内容に問題有り

2401

認証エラー

3404

存在しない

4429

一定時間内のアクセス数超過

API にアクセスされた※現在制限はないが将来的に制限する可能性があるため、考慮する必要がある。
5500

サーバ内部エラー

6503

メンテナンス中

レスポンスボディ(本文)に JSON 形式でエラーな内容を記述する。
No.

パラメータ名

内容

1

code

HTTP レスポンスコード

2

message

エラーの詳細な内容

レスポンス例{"code": 401,"message": " API キー認証エラー"}-6-

2.8. API のパラメータ
2.9. トンネル簡易検索
URL ： ○○/xROAD/api/v1/tunnels?検索条件
メソッド： GET
検索条件にマッチするトンネルデータを過去分も含めてすべて取得する。
検索条件はクエリパラメータとして設定する。
返却されるデータは、無料項目のみ。
No.

パラメータ

内容省略時

1

shisetsu

施設 ID

すべてのトンネル

2

pref

都道府県コード指定

すべての都道府県

3

city

市区町村コード指定

すべての市区町村

4area

東西南北端の座標を指定し、範囲内の施設を抽出

すべての範囲する。南端緯度、北端緯度、西端経度、東端経度を10進法表記のカンマ区切りで記述。
5

name

施設名に指定キーワードを含む施設データを抽

すべてのトンネル名出。キーワードは URL エスケープが必要。
6

furigana

施設名フリガナに指定キーワードを含む施設デすべてのフリガナータを抽出。キーワードは URL エスケープが必要。
7

nendo

指定年度が合致するトンネルデータを抽出

すべての年度

8

limit

一度に参照するトンネルデータの件数を指定

100 件

最大10,000件
9offset検索結果の参照開始位置を指定

0

検索 URL サンプル集
千葉県の 2020 年度のトンネルデータを検索
GET ○○/xROAD/api/v1/tunnels?pref=12&nendo=2020
北緯 35.35～35.44 東経 139.35～139.46 に囲まれた範囲でトンネルデータを検索
GET ○○/xROAD/api/v1/tunnels?area=35.35,35.44,139.35,139.46「蔵前」というキーワードを施設名に含むトンネルデータを検索
GET ○○/xROAD/api/v1/tunnels?name=%E8%94%B5%E5%89%8D%E6%A9%8B-7-

2.1. 最新トンネル検索
URL：○○/xROAD/api/v1/tunnels/lastest?検索条件

メソッド： GET
検索条件にマッチするトンネルデータを最新分のみ取得する。
検索条件は前項の最新データ参照 API と同じ。
返却されるデータは、無料項目のみ。

使用例
北緯 35.35～35.44 東経 139.35～139.46 に囲まれた範囲で最新のトンネルデータを検索
GET○○/xROAD/api/v1/tunnels/lastest?area=35.35,35.44,139.35,139.46

Web 地図上にアイコンを表示する場合などに使用できる。

2.1. 詳細検索
URL： ○○/xROAD/api/v1/tunnels/search

メソッド： POST(GET の文字数制限を回避するために、POST)

メソッドを用いてリクエストボディに JSON 形式で検索条件を渡す。
返却されるデータは、有料項目を含めすべてのデータを取得。
多くのトンネルが対象となる検索の場合は、時間がかかるため留意する必要がある。
※１リクエスト、１分以内を目途に分割して検索してください。
No.

種類

1

検索条件配列key(querys)

内容

省略時

検索項目を指し示すキー

入力必須

入れ子の項目はドットで繋いで表現する

2

value

検索する値

入力必須

3

op

比 較 方 法 。1:'＝’ 等 し い 。2:'≠'等

入力必須

し く な い 。 3:'<'検索値より小さい。
4:'>'検索値より大き い。5:'≦'検索値以下。6:'≧'検索値以上。7:検索値を含
む
4

並び順配列

Key(sortOrder)

検索項目を指し示すキー

結果は不入れ子の項目はドットで繋いで表現する

定

6order

ソート方向。0:昇順。1:降順

0:昇順

7offset検索結果の参照開始位置を指定

0-8-8limit

一度に参照する施設データの件数を指定

100 件

最大 10,000件
9

lastOnly

0:すべて

0:すべて

1:最新点検のみ取得
10blank_flg

データ種

syogen_detail類(dataKindtenken_detail)sagyo_flg

0:空欄理由出力なし

0:出力な

1:空欄理由出力あり

し諸元詳細を出力するか。

0:無料範

0:無料範囲1:出力する

囲

点検詳細を出力するか。

0: 無料範

0: 無料範囲1:出力する

囲

作業内容フラグを出力するか。

0:なし

0: 無料範囲1:出力する
hijyouyou

非常用施設を出力するか。

0:なし

0:なし 1:出力する
fuzoku

道路附属物等を出力するか。

0:なし

0:なし 1:出力する
hijyoumeisai

非常用設備詳細を出力するか。

0:なし

0:なし 1:出力する
sonota

その他を出力するか。

0:なし

0:なし 1:出力する
senyou

占用物件を出力するか。

0:なし

0:なし 1:出力する
tunnelspan

トンネル情報一覧を出力するか。

0:なし

0:なし 1:出力する
hosyu

補修維持管理履歴を出力するか。

0:なし

0:なし 1:出力する
tenkenhontai

点検本体工を出力するか。

0:なし

0:なし 1:出力する
tenkenfuzoku

点検附属物取付を出力するか。

0:なし

0:なし 1:出力する
tenkenrireki

点検措置履歴を出力するか。

0:なし

0:なし 1:出力する
tenkenfuka

点検不可を出力するか。
0:なし 1:出力する-9-0:なしzumen

トンネル図面類情報を出力するか。

0:なし

0:なし 1:出力する
tenkenichizu

トンネル変状・異常箇所写真位置図を出0:なし

力するか。
0:なし 1:出力する
tenkentenkaiz

トンネル全体変状展開図を出力するか。

u0:なし 1:出力する

tenkenkikiten

トンネル全体変状展開図(機器活用時)をkaizu

出力するか。

0:なし

0:なし

0:なし 1:出力する
tenkenspanten

スパン別変状詳細展開図を出力するか。

kaizu

0:なし 1:出力する

tenkensyoken

健全性の診断の区分の所見を出力するか。
0:なし 1:出力するパラメータ入力例）トンネル長が 100m 以上のトンネルデータの参照をリクエスト{"querys": [{"key": "syogen.enchou","value": "100","op": "6"},{・・・・・・- 10 -

0:なし

0:なし

2.2. ファイル取得 API
2.2.1. 点検報告書様式ファイル取得 API
URL： ○○/xROAD/api/v1/tunnels/report77/{施設 ID}/{年度}
メソッド： GET
検索条件にマッチする第７７条点検報告書又は直轄点検調書ファイルを取得する。
2.2.2. 付属ファイルリスト取得 API
URL: ○○/xROAD/api/v1/tunnels/otherFileList?{検索条件}

メソッド： GET
検索条件にマッチするトンネルデータに紐づく付属ファイル(画像、PDF 等)の、ファイル ID等のファイルリスト(情報)を参照する。
検索条件のパラメータの形式は、トンネルデータ参照 API のものと同一である。
例) 施設 ID35.1234,130.12345 のトンネルに紐づくファイルリストを取得する
GET ○○/xROAD/api/v1/tunnels/otherFileList?shisetsu=35.1234,130.12345

レスポンス
ダウンロードに必要な情報が、ダウンロードするファイルの個数分だけ配列の形で返す。
レスポンス例。resultSet などは省略して表記{
result: {[{file_id: 7653232,file_name: “◯◯.jpg”,shisetsu_id: “35.12345,130.12345”,
shisetsu_meisyou: “◯◯トンネル”},{
file_id: 7653233,
file_name: “◯◯トンネル 1.jpg”,
shisetsu_id: “35.12345,130.12345”,
shisetsu_meisyou: “◯◯トンネル”}],}}
shisetsu_id を使って次項の API でダウンロードする。
- 11 -

2.2.3. 付属ファイル取得 API
URL： ○○/xROAD/api/v1/tunnels/otherFile/{ファイル ID}

メソッド： GET
前項のファイルリスト取得 API を利用して取得したファイル ID に合致するファイルを取得する。
例) ファイル ID7654321 のファイルをダウンロードする
GET ○○/xROAD/api/v1/tunnels/otherFile/7654321

2.2.4. イメージファイル取得 API
URL： ○○/xROAD/api/v1/tunnels/imageFile/{ファイル ID}

メソッド： GET
高度検索 API を利用して取得したファイル ID に合致するファイルを取得する。
例) ファイル ID7654321 のファイルをダウンロードする
GET ○○/xROAD/api/v1/tunnels/imageFile/7654321

2.2.5. 台帳 PDF 取得 API
URL： ○○/xROAD/api/v1/tunnels/daicho/{施設 ID}

メソッド： GET
指定した施設の台帳 PDF ファイルを取得する。
例) 施設 ID35.1234,130.12345 の台帳 PDF ファイルをダウンロードする
GET ○○/xROAD/api/v1/tunnels/daicho/35.1234,130.12345- 12 -

2.3. 日付表記
・年データは西暦とする。フォーマットは YYYY例) 2021
・年月フォーマットは YYYYMM例) 202109
・年月日フォーマットは YYYYMMDD例) 20210901
2.4. API 認証
API キー認証方式
API を利用するアプリごとに API キーを発行し、API アクセス時にその API キーを HTTPヘッダに記述することによって認証する。
発行時に登録したドメイン名や IP アドレスからのアクセスは拒否する。
•API キー記述ヘッダ
API-key•

API キーフォーマット
半角英数字 40 文字

2.5. 詳細検索パラメータ
別紙のパラメータ一覧をご覧ください。

- 13 -